A B C D F G I M N O P R S T U V

A

accept(String, Object) - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileDataFilter

Checks if given caseFileData matches defined filter.

addAll(Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Adds all elements of data collection to existing case file (replacing already existing data that matches with input)

addCaseComment(String, String, String, String...) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new comment to the case

addDataToCaseFile(String, String, Object, String...) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds given named value into case file of given case.

addDataToCaseFile(String, Map<String, Object>, String...) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds complete map to case file of given case.

addDynamicSubprocess(String, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new subprocess (identified by process id) to given process instance.

addDynamicSubprocess(Long, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new subprocess (identified by process id) to case.

addDynamicSubprocessToStage(String, String, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new subprocess (identified by process id) to given process instance.

addDynamicSubprocessToStage(Long, String, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new subprocess (identified by process id) to case.

addDynamicTask(String, TaskSpecification) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new user task to specified case.

addDynamicTask(Long, TaskSpecification) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new user task to specified process instance.

addDynamicTaskToStage(String, String, TaskSpecification) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new user task to specified case and stage.

addDynamicTaskToStage(Long, String, TaskSpecification) - Method in interface org.jbpm.casemgmt.api.CaseService

Adds new user task to specified case and stage on given process instance.

AdHocFragment - Interface in org.jbpm.casemgmt.api.model

Represents single ad hoc fragment that can be triggered.

AdHocFragmentNotFoundException - Exception in org.jbpm.casemgmt.api

Thrown when accessing ad hoc fragment that does not exist

AdHocFragmentNotFoundException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.AdHocFragmentNotFoundException

AdHocFragmentNotFoundException(String) - Constructor for exception org.jbpm.casemgmt.api.AdHocFragmentNotFoundException

ADMIN_ROLE - Static variable in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

afterCaseCancelled(CaseCancelEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseClosed(CaseCloseEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseCommentAdded(CaseCommentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseCommentRemoved(CaseCommentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseCommentUpdated(CaseCommentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseDataAdded(CaseDataEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseDataRemoved(CaseDataEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseDestroyed(CaseDestroyEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseReopen(CaseReopenEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseRoleAssignmentAdded(CaseRoleAssignmentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseRoleAssignmentRemoved(CaseRoleAssignmentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterCaseStarted(CaseStartEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterDynamicProcessAdded(CaseDynamicSubprocessEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

afterDynamicTaskAdded(CaseDynamicTaskEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

assignToCaseRole(String, String, OrganizationalEntity) - Method in interface org.jbpm.casemgmt.api.CaseService

Assigns given entity (user or group) to case role for a given case.

AuthorizationManager - Interface in org.jbpm.casemgmt.api.auth

Responsible for authorizing access to case instances based on the context.

AuthorizationManager.ProtectedOperation - Enum in org.jbpm.casemgmt.api.auth

B

beforeCaseCancelled(CaseCancelEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseClosed(CaseCloseEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseCommentAdded(CaseCommentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseCommentRemoved(CaseCommentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseCommentUpdated(CaseCommentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseDataAdded(CaseDataEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseDataRemoved(CaseDataEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseDestroyed(CaseDestroyEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseReopen(CaseReopenEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseRoleAssignmentAdded(CaseRoleAssignmentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseRoleAssignmentRemoved(CaseRoleAssignmentEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeCaseStarted(CaseStartEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeDynamicProcessAdded(CaseDynamicSubprocessEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

beforeDynamicTaskAdded(CaseDynamicTaskEvent) - Method in interface org.jbpm.casemgmt.api.event.CaseEventListener

C

cancelCase(String) - Method in interface org.jbpm.casemgmt.api.CaseService

Cancels case with given case id (including all attached process instances if any).

CaseActiveException - Exception in org.jbpm.casemgmt.api

Thrown then reopening a case that is already started/reopened

CaseActiveException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.CaseActiveException

CaseActiveException(String) - Constructor for exception org.jbpm.casemgmt.api.CaseActiveException

CaseCancelEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of case close operation

CaseCancelEvent(String, String, CaseFileInstance, List<Long>) - Constructor for class org.jbpm.casemgmt.api.event.CaseCancelEvent

CaseCloseEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of case close operation

CaseCloseEvent(String, String, CaseFileInstance, String) - Constructor for class org.jbpm.casemgmt.api.event.CaseCloseEvent

CaseCommentEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of case comment related operation

CaseCommentEvent(String, String, CaseFileInstance, CommentInstance) - Constructor for class org.jbpm.casemgmt.api.event.CaseCommentEvent

CaseCommentNotFoundException - Exception in org.jbpm.casemgmt.api

Thrown then accessing or manipulating case comment that does not exist

CaseCommentNotFoundException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.CaseCommentNotFoundException

CaseCommentNotFoundException(String) - Constructor for exception org.jbpm.casemgmt.api.CaseCommentNotFoundException

CaseDataEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of case data (that is part of case file) related operation

CaseDataEvent(String, String, CaseFileInstance, String, Map<String, Object>) - Constructor for class org.jbpm.casemgmt.api.event.CaseDataEvent

CaseDefinition - Interface in org.jbpm.casemgmt.api.model

Describes case structure and requirements.

CaseDefinitionNotFoundException - Exception in org.jbpm.casemgmt.api

Thrown then accessing case definition that does not exist

CaseDefinitionNotFoundException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.CaseDefinitionNotFoundException

CaseDefinitionNotFoundException(String) - Constructor for exception org.jbpm.casemgmt.api.CaseDefinitionNotFoundException

CaseDestroyEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of case destroy operation

CaseDestroyEvent(String, String, CaseFileInstance, List<Long>) - Constructor for class org.jbpm.casemgmt.api.event.CaseDestroyEvent

CaseDynamicSubprocessEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of dynamic subprocess add to case operation

CaseDynamicSubprocessEvent(String, String, CaseFileInstance, String, Map<String, Object>, long) - Constructor for class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent

CaseDynamicSubprocessEvent(String, String, CaseFileInstance, String, Map<String, Object>, long, long) - Constructor for class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent

CaseDynamicTaskEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of dynamic task add to case operation

CaseDynamicTaskEvent(String, String, CaseFileInstance, String, Map<String, Object>, long) - Constructor for class org.jbpm.casemgmt.api.event.CaseDynamicTaskEvent

CaseEvent - Class in org.jbpm.casemgmt.api.event

Represents generic event of case operation

CaseEvent(String, String, CaseFileInstance) - Constructor for class org.jbpm.casemgmt.api.event.CaseEvent

CaseEventListener - Interface in org.jbpm.casemgmt.api.event

Case event listener that is invoked upon various operation related to a case.

CaseFileDataFilter - Interface in org.jbpm.casemgmt.api.model.instance

Provides mechanism to filter case file data to return only expected results.

CaseFileInstance - Interface in org.jbpm.casemgmt.api.model.instance

Represent contextual data of a given Case

CaseFileItem - Interface in org.jbpm.casemgmt.api.model

Simple view on individual CaseFile data item.

CaseIdGenerator - Interface in org.jbpm.casemgmt.api.generator

Responsible for generating and keeping track of generated case identifiers.

CaseInstance - Interface in org.jbpm.casemgmt.api.model.instance

Describes case structure and requirements.

CaseMilestone - Interface in org.jbpm.casemgmt.api.model

Represents intermediate goal within a case

CaseMilestoneInstance - Interface in org.jbpm.casemgmt.api.model.instance

Represents single instance of a milestone in a case.

CaseNotFoundException - Exception in org.jbpm.casemgmt.api

Thrown then accessing case that does not exist

CaseNotFoundException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.CaseNotFoundException

CaseNotFoundException(String) - Constructor for exception org.jbpm.casemgmt.api.CaseNotFoundException

CasePrefixNotFoundException - Exception in org.jbpm.casemgmt.api.generator

CasePrefixNotFoundException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.generator.CasePrefixNotFoundException

CasePrefixNotFoundException(String) - Constructor for exception org.jbpm.casemgmt.api.generator.CasePrefixNotFoundException

CaseReopenEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of start case operation

CaseReopenEvent(String, String, CaseFileInstance, String, String, Map<String, Object>) - Constructor for class org.jbpm.casemgmt.api.event.CaseReopenEvent

CaseReopenEvent(String, String, CaseFileInstance, String, String, Map<String, Object>, Long) - Constructor for class org.jbpm.casemgmt.api.event.CaseReopenEvent

CaseRole - Interface in org.jbpm.casemgmt.api.model

Represents single role assigned to a given case.

CaseRoleAssignmentEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of role assignment on a case operation

CaseRoleAssignmentEvent(String, String, CaseFileInstance, String, OrganizationalEntity) - Constructor for class org.jbpm.casemgmt.api.event.CaseRoleAssignmentEvent

CaseRoleInstance - Interface in org.jbpm.casemgmt.api.model.instance

Defines single role instance with currently available assignments.

CaseRuntimeDataService - Interface in org.jbpm.casemgmt.api

Provides access to case(s) and its runtime data such as: available cases available milestones available stages Note: CaseInstance.getCaseFile() will always be empty when using CaseRuntimeDataService.

CaseService - Interface in org.jbpm.casemgmt.api

Provides case management operations.

CaseStage - Interface in org.jbpm.casemgmt.api.model

Represents self contained part of case that does include number of other activities and potentially other stages

CaseStageInstance - Interface in org.jbpm.casemgmt.api.model.instance

Represents stage within case on runtime, provides information about active tasks, subprocesses etc.

CaseStartEvent - Class in org.jbpm.casemgmt.api.event

Represents occurrence of start case operation

CaseStartEvent(String, String, String, String, CaseFileInstance) - Constructor for class org.jbpm.casemgmt.api.event.CaseStartEvent

CaseStartEvent(String, String, String, String, CaseFileInstance, Long) - Constructor for class org.jbpm.casemgmt.api.event.CaseStartEvent

CaseStatus - Enum in org.jbpm.casemgmt.api.model

checkAuthorization(String) - Method in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

Checks if the caller (based on identity provider) is authorized to work with a case identified by caseId

checkCommentAuthorization(String, CaseFileInstance, CommentInstance) - Method in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

Check if caller (based on identity provider) is authorized to manipulate given comment

checkDataAuthorization(String, CaseFileInstance, Collection<String>) - Method in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

Check if caller (based on identity provider) is authorized to manipulate given data

checkOperationAuthorization(String, AuthorizationManager.ProtectedOperation) - Method in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

Checks if the caller (based on identity provider) is authorized to perform given operation on a case.

closeCase(String, String) - Method in interface org.jbpm.casemgmt.api.CaseService

Closes case with given case id (including all attached process instances if any).

CommentInstance - Interface in org.jbpm.casemgmt.api.model.instance

Represents single case comment instance that can be attached to a case at any time by case participants

CommentSortBy - Enum in org.jbpm.casemgmt.api.model.instance

D

DEFAULT_PREFIX - Static variable in interface org.jbpm.casemgmt.api.model.CaseDefinition

destroyCase(String) - Method in interface org.jbpm.casemgmt.api.CaseService

Permanently destroys case identified by given case id.

F

filterByCommentAuthorization(String, CaseFileInstance, List<CommentInstance>) - Method in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

Filters provided comments by their restrictions.

filterByDataAuthorization(String, CaseFileInstance, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

Filters provided data by data restrictions.

fromId(int) - Static method in enum org.jbpm.casemgmt.api.model.CaseStatus

fromIdList(List<Integer>) - Static method in enum org.jbpm.casemgmt.api.model.CaseStatus

fromName(String) - Static method in enum org.jbpm.casemgmt.api.model.CaseStatus

fromNameList(List<String>) - Static method in enum org.jbpm.casemgmt.api.model.CaseStatus

G

generate(String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.generator.CaseIdGenerator

Generates next value for given prefix.

getAchievedAt() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseMilestoneInstance

In case this milestone is achieved, returns date at it was achieved.

getAchievementCondition() - Method in interface org.jbpm.casemgmt.api.model.CaseMilestone

Returns condition that will indicate this mile stone is achieved.

getActiveNodes() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseStageInstance

Returns currently active nodes within this stage

getActiveNodesForCase(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns active nodes in given case regardless in what process instance they belong to.

getAdHocFragments() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns available adhoc fragments that can be signaled.

getAdHocFragments() - Method in interface org.jbpm.casemgmt.api.model.CaseStage

Returns names of the adhoc fragments within this stage that can be triggered.

getAdHocFragments() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseStageInstance

Returns names of the adhoc fragments within this stage that can be triggered.

getAdHocFragmentsForCase(String) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns list of AdHocFragments available in given case.

getAuthor() - Method in interface org.jbpm.casemgmt.api.model.instance.CommentInstance

Author of the comment

getCardinality() - Method in interface org.jbpm.casemgmt.api.model.CaseRole

Returns maximum cardinality for this role - maximum assigned entities per case instance.

getCase(String, String) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns case definition identified by caseDefinitionId that belongs to given deploymentId.

getCaseComments(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns all case comments sorted by date

getCaseComments(String, CommentSortBy, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns all case comments sorted with given sortBy

getCaseDefinitionId() - Method in class org.jbpm.casemgmt.api.event.CaseReopenEvent

Returns case definition id

getCaseDefinitionId() - Method in class org.jbpm.casemgmt.api.event.CaseStartEvent

Returns case definition id

getCaseDefinitionId() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns case definition id

getCaseDescription() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns case description

getCaseEndDate() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Returns end date of the associated case

getCaseFile() - Method in class org.jbpm.casemgmt.api.event.CaseEvent

getCaseFile() - Method in class org.jbpm.casemgmt.api.event.CaseStartEvent

Returns case file associated with the case

getCaseFile() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns case file associated with this case.

getCaseFileInstance(String) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns Case file for give case id

getCaseId() - Method in class org.jbpm.casemgmt.api.event.CaseEvent

Returns case identifier

getCaseId() - Method in interface org.jbpm.casemgmt.api.model.CaseFileItem

Returns unique case identifier that this item belongs to

getCaseId() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Returns case id this case file is associated with.

getCaseId() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns case identifier of this case.

getCaseInstance(String) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns case instance (only if it's active) identified by given case id - does not load case file, roles, milestones nor stages.

getCaseInstance(String, boolean, boolean, boolean, boolean) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns case instance (only if it's active) identified by given case id with options on what should be fetched

getCaseInstanceById(String) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns case instance for given case id if the caller of this class is authorized to see the case instance

getCaseInstanceDataItems(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns case file data items (as simple descriptions not actual values) for given case instance

getCaseInstanceDataItemsByName(String, List<String>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns case file data items (as simple descriptions not actual values) for given case instance filtered by item names

getCaseInstanceDataItemsByType(String, List<String>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns case file data items (as simple descriptions not actual values) for given case instance filtered by item types

getCaseInstanceMilestones(String, boolean, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns milestones for given case instance, identified by case id.

getCaseInstances(QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all available active case instances

getCaseInstances(List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all available active case instances that match given statuses

getCaseInstancesAnyRole(List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns case instances that given user (via identity provider) is involved in in any role.

getCaseInstancesByDateItem(String, List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all available active case instances that match given statuses and has case file data item with given name

getCaseInstancesByDateItemAndValue(String, String, List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all available active case instances that match given statuses and has case file data item with given name and value

getCaseInstancesByDefinition(String, List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all available case instances;

getCaseInstancesByDeployment(String, List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all available case instances;

getCaseInstancesByRole(String, List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns cases instances that given user (via identity provider) has access to with given role.

getCaseInstancesOwnedBy(String, List<CaseStatus>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all case instances owned by given user

getCaseInstanceStages(String, boolean, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns stages of given case instance, identified by case id.

getCaseMilestones() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns available case milestones for this case.

getCaseMilestones() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns available case milestones for this case.

getCaseReopenDate() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Returns reopen date of the associated case

getCaseRoleAssignments(String) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns role assignments for given case

getCaseRoles() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns case roles for this case.

getCaseRoles() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns case roles for this case.

getCases(QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns available cases.

getCases(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns available cases which matching filter that applies to case name (usually represented by process id or name).

getCasesByDeployment(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns available cases for given deployment id

getCaseStages() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns available case stages in this case.

getCaseStages() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns available case stages in this case.

getCaseStartDate() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Returns start date of the associated case

getCaseTasksAssignedAsBusinessAdmin(String, String, List<Status>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all tasks associated with given case id that are eligible for user to see as business admin role.

getCaseTasksAssignedAsPotentialOwner(String, String, List<Status>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all tasks associated with given case id that are eligible for user to see.

getCaseTasksAssignedAsStakeholder(String, String, List<Status>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns all tasks associated with given case id that are eligible for user to see in task stakeholder role.

getComment() - Method in class org.jbpm.casemgmt.api.event.CaseCloseEvent

getComment() - Method in class org.jbpm.casemgmt.api.event.CaseCommentEvent

Returns actual CommentInstance that is added or removed

getComment() - Method in interface org.jbpm.casemgmt.api.model.instance.CommentInstance

Actual comment test

getCompletedAt() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns completion date of this case

getCompletedNodesForCase(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns completed nodes in given case regardless in what process instance they belong to.

getCompletionMessage() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns completion message (if any) of this case

getCreatedAt() - Method in interface org.jbpm.casemgmt.api.model.instance.CommentInstance

Exact date at which comment was added.

getData() - Method in class org.jbpm.casemgmt.api.event.CaseDataEvent

Returns data affected (added or removed)

getData() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent

Returns parameters used when starting sub process instance

getData() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicTaskEvent

Returns dynamic task input data

getData() - Method in class org.jbpm.casemgmt.api.event.CaseReopenEvent

Returns case file associated with the case

getData(CaseFileDataFilter) - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Returns filtered available case data for given case.

getDataAccessRestrictions() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns default case file data restrictions.

getDefinitionId() - Method in class org.jbpm.casemgmt.api.event.CaseDataEvent

getDeploymentId() - Method in class org.jbpm.casemgmt.api.event.CaseReopenEvent

Returns deployment id that case belongs to

getDeploymentId() - Method in class org.jbpm.casemgmt.api.event.CaseStartEvent

Returns deployment id that case belongs to

getDeploymentId() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns deployment id

getDeploymentId() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns deployment id

getEntity() - Method in class org.jbpm.casemgmt.api.event.CaseRoleAssignmentEvent

Returns organizational entity (user or group) that the assignment is changed for

getId() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns id of the case that shall be used to instantiate new instance of this case

getId() - Method in interface org.jbpm.casemgmt.api.model.CaseMilestone

Returns id of the milestone.

getId() - Method in interface org.jbpm.casemgmt.api.model.CaseStage

Returns id of the stage

getId() - Method in enum org.jbpm.casemgmt.api.model.CaseStatus

getId() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseMilestoneInstance

Returns id of the milestone.

getId() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseStageInstance

Returns id of this stage.

getId() - Method in interface org.jbpm.casemgmt.api.model.instance.CommentInstance

Returns unique id assigned to this comment

getIdentifier() - Method in interface org.jbpm.casemgmt.api.generator.CaseIdGenerator

Identifier of the generator so it can be found and registered at runtime

getIdentifierPrefix() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns case identifier prefix to be used for every instance of this case.

getLastModified() - Method in interface org.jbpm.casemgmt.api.model.CaseFileItem

Returns last modification timestamp for this data item

getLastModifiedBy() - Method in interface org.jbpm.casemgmt.api.model.CaseFileItem

Returns user id who made the last modification of this data item

getName() - Method in interface org.jbpm.casemgmt.api.model.AdHocFragment

Returns name of the ad hoc fragment

getName() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns case name of this case.

getName() - Method in interface org.jbpm.casemgmt.api.model.CaseFileItem

Returns name of the data item

getName() - Method in interface org.jbpm.casemgmt.api.model.CaseMilestone

Returns name of the milestone.

getName() - Method in interface org.jbpm.casemgmt.api.model.CaseRole

Returns name of the role

getName() - Method in interface org.jbpm.casemgmt.api.model.CaseStage

Returns name of the stage

getName() - Method in enum org.jbpm.casemgmt.api.model.CaseStatus

getName() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseMilestoneInstance

Returns name of the milestone.

getName() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseStageInstance

Returns name of this stage.

getNodeType() - Method in interface org.jbpm.casemgmt.api.dynamic.TaskSpecification

Returns the type of the node that will be added.

getNodeType() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicTaskEvent

Returns type of the node of the dynamic task

getOwner() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns owner of the case - usually one who started the case

getParameters() - Method in interface org.jbpm.casemgmt.api.dynamic.TaskSpecification

Optional set of parameters to be given to created dynamic task.

getProcessDefinitions(QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns process definitions that are not considered as case definitions.

getProcessDefinitions(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns process definitions that are not considered as case definitions and are filtered by process id or name.

getProcessDefinitionsByDeployment(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns process definitions that are not considered as case definitions that belongs to given deployment.

getProcessId() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent

Returns process id of the subprocess to be started

getProcessInstanceId() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent

Returns process instance id of the parent process where subprocess is added to

getProcessInstanceId() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicTaskEvent

Returns process instance id of process where dynamic task was added

getProcessInstanceId() - Method in class org.jbpm.casemgmt.api.event.CaseReopenEvent

Returns process instance id of the case process instance

getProcessInstanceId() - Method in class org.jbpm.casemgmt.api.event.CaseStartEvent

Returns process instance id of the case process instance

getProcessInstanceIds() - Method in class org.jbpm.casemgmt.api.event.CaseCancelEvent

Returns list of process instances that were aborted as part of cancel case operation

getProcessInstanceIds() - Method in class org.jbpm.casemgmt.api.event.CaseDestroyEvent

Returns list of process instances that were aborted as part of cancel case operation

getProcessInstancesForCase(String, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns process instances found for given case id.

getProcessInstancesForCase(String, List<Integer>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService

Returns process instances found for given case id.

getRestrictedTo() - Method in interface org.jbpm.casemgmt.api.model.instance.CommentInstance

List of case roles given comment is restricted to

getRole() - Method in class org.jbpm.casemgmt.api.event.CaseRoleAssignmentEvent

Returns name of the role that assignment is changed for

getRoleAssignments() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseRoleInstance

Returns collection of assignments for this case role instance.

getRoleName() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseRoleInstance

Returns case role name this instance is associated with.

getStartedAt() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns start date of this case

getStatus() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseInstance

Returns status of the case

getStatus() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseMilestoneInstance

Returns status of this milestone

getStatus() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseStageInstance

Returns status of this stage

getSubProcessInstanceId() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent

Returns subprocess instance id after it was started.

getType() - Method in interface org.jbpm.casemgmt.api.model.AdHocFragment

Returns type of the ad hoc fragment (human task, milestone, service task, etc)

getType() - Method in interface org.jbpm.casemgmt.api.model.CaseFileItem

Returns type of the data item - FQCN

getUser() - Method in class org.jbpm.casemgmt.api.event.CaseEvent

Returns user who performed that operation

getValue() - Method in interface org.jbpm.casemgmt.api.model.CaseFileItem

Returns "toString" version of the latest value of the data item

getVersion() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition

Returns version of this case

I

isAchieved() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseMilestoneInstance

Indicates if this milestone is already achieved or not.

isMandatory() - Method in interface org.jbpm.casemgmt.api.model.CaseMilestone

Defines if this milestone is required before case completion.

M

MilestoneStatus - Enum in org.jbpm.casemgmt.api.model.instance

Represents possible states of a case milestone

N

newCaseFileInstance(String, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Builds and returns new CaseFileInstance with given data.

newCaseFileInstance(String, String, Map<String, Object>, Map<String, OrganizationalEntity>) - Method in interface org.jbpm.casemgmt.api.CaseService

Builds and returns new CaseFileInstance with given data and roles assignments.

newCaseFileInstanceWithRestrictions(String, String, Map<String, Object>, Map<String, List<String>>) - Method in interface org.jbpm.casemgmt.api.CaseService

Builds and returns new CaseFileInstance with given data.

newCaseFileInstanceWithRestrictions(String, String, Map<String, Object>, Map<String, OrganizationalEntity>, Map<String, List<String>>) - Method in interface org.jbpm.casemgmt.api.CaseService

Builds and returns new CaseFileInstance with given data and roles assignments.

newGroup(String) - Method in interface org.jbpm.casemgmt.api.CaseService

Creates new group with given id;

newHumanTaskSpec(String, String, String, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns new TaskSpecification describing user task so it can be created as dynamic task.

newTaskSpec(String, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Returns new TaskSpecification describing generic (work item based) task so it can be added as dynamic task.

newUser(String) - Method in interface org.jbpm.casemgmt.api.CaseService

Creates new user with given id;

O

org.jbpm.casemgmt.api - package org.jbpm.casemgmt.api

org.jbpm.casemgmt.api.auth - package org.jbpm.casemgmt.api.auth

org.jbpm.casemgmt.api.dynamic - package org.jbpm.casemgmt.api.dynamic

org.jbpm.casemgmt.api.event - package org.jbpm.casemgmt.api.event

org.jbpm.casemgmt.api.generator - package org.jbpm.casemgmt.api.generator

org.jbpm.casemgmt.api.model - package org.jbpm.casemgmt.api.model

org.jbpm.casemgmt.api.model.instance - package org.jbpm.casemgmt.api.model.instance

OWNER_ROLE - Static variable in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

P

PUBLIC_GROUP - Static variable in interface org.jbpm.casemgmt.api.auth.AuthorizationManager

R

register(String) - Method in interface org.jbpm.casemgmt.api.generator.CaseIdGenerator

Should be called only one time per given prefix.

remove(CaseFileDataFilter) - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Remove permanently all data from existing case file that matches given filter

removeAll() - Method in interface org.jbpm.casemgmt.api.model.instance.CaseFileInstance

Removes permanently all data, which is essentially a clear of the entire case file

removeCaseComment(String, String) - Method in interface org.jbpm.casemgmt.api.CaseService

Removes given comment from the case comments list

removeDataFromCaseFile(String, String) - Method in interface org.jbpm.casemgmt.api.CaseService

Removes given variable (stored under name) from case file of given case.

removeDataFromCaseFile(String, List<String>) - Method in interface org.jbpm.casemgmt.api.CaseService

Removes given variables (stored under variableNames) from case file of given case.

removeFromCaseRole(String, String, OrganizationalEntity) - Method in interface org.jbpm.casemgmt.api.CaseService

Removes given entity (user or group) from the case role for a given case.

reopenCase(String, String, String) - Method in interface org.jbpm.casemgmt.api.CaseService

Reopens case given by case id by starting another instance of case definition.

reopenCase(String, String, String, Map<String, Object>) - Method in interface org.jbpm.casemgmt.api.CaseService

Reopens case given by case id by starting another instance of case definition.

RoleCardinalityReachedException - Exception in org.jbpm.casemgmt.api

Thrown when assigning entities (user or group) to role instance where assigned already entities reached defined cardinality.

RoleCardinalityReachedException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.RoleCardinalityReachedException

RoleCardinalityReachedException(String) - Constructor for exception org.jbpm.casemgmt.api.RoleCardinalityReachedException

S

StageNotFoundException - Exception in org.jbpm.casemgmt.api

Thrown when accessing stage that does not exist

StageNotFoundException(String, Throwable) - Constructor for exception org.jbpm.casemgmt.api.StageNotFoundException

StageNotFoundException(String) - Constructor for exception org.jbpm.casemgmt.api.StageNotFoundException

StageStatus - Enum in org.jbpm.casemgmt.api.model.instance

Represents possible states of a case stage

startCase(String, String) - Method in interface org.jbpm.casemgmt.api.CaseService

Starts a new case for given definition with empty case file.

startCase(String, String, CaseFileInstance) - Method in interface org.jbpm.casemgmt.api.CaseService

Starts a new case for given definition with given case file.

T

TaskSpecification - Interface in org.jbpm.casemgmt.api.dynamic

Provides all required information about a dynamic task so it can be represented as correct node type when added to case/process instance.

toString() - Method in class org.jbpm.casemgmt.api.event.CaseCancelEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseCloseEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseCommentEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseDataEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseDestroyEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseDynamicTaskEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseReopenEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseRoleAssignmentEvent

toString() - Method in class org.jbpm.casemgmt.api.event.CaseStartEvent

triggerAdHocFragment(String, String, Object) - Method in interface org.jbpm.casemgmt.api.CaseService

Triggers given by fragmentName adhoc element (such as task, milestone) within given case.

triggerAdHocFragment(Long, String, Object) - Method in interface org.jbpm.casemgmt.api.CaseService

Triggers given by fragmentName adhoc element (such as task, milestone) within given process instance

U

unregister(String) - Method in interface org.jbpm.casemgmt.api.generator.CaseIdGenerator

Unregisters given prefix from the generator.

updateCaseComment(String, String, String, String, String...) - Method in interface org.jbpm.casemgmt.api.CaseService

Updated given comment with entire text provided

V

valueOf(String) - Static method in enum org.jbpm.casemgmt.api.auth.AuthorizationManager.ProtectedOperation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jbpm.casemgmt.api.model.CaseStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jbpm.casemgmt.api.model.instance.CommentSortBy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jbpm.casemgmt.api.model.instance.MilestoneStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jbpm.casemgmt.api.model.instance.StageStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jbpm.casemgmt.api.auth.AuthorizationManager.ProtectedOperation

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jbpm.casemgmt.api.model.CaseStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jbpm.casemgmt.api.model.instance.CommentSortBy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jbpm.casemgmt.api.model.instance.MilestoneStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jbpm.casemgmt.api.model.instance.StageStatus

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D F G I M N O P R S T U V