- 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, List<Long>) - Constructor for class org.jbpm.casemgmt.api.event.CaseCancelEvent
-
- CaseCommentEvent - Class in org.jbpm.casemgmt.api.event
-
Represents occurrence of case comment related operation
- CaseCommentEvent(String, 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, 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.
- CaseDestroyEvent - Class in org.jbpm.casemgmt.api.event
-
Represents occurrence of case destroy operation
- CaseDestroyEvent(String, 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, Map<String, Object>, long) - Constructor for class org.jbpm.casemgmt.api.event.CaseDynamicSubprocessEvent
-
- CaseDynamicSubprocessEvent(String, 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, 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) - 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
- 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, String, Map<String, Object>) - Constructor for class org.jbpm.casemgmt.api.event.CaseReopenEvent
-
- CaseReopenEvent(String, 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, 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
- 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, CaseFileInstance) - Constructor for class org.jbpm.casemgmt.api.event.CaseStartEvent
-
- CaseStartEvent(String, String, String, CaseFileInstance, Long) - Constructor for class org.jbpm.casemgmt.api.event.CaseStartEvent
-
- 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
-
- 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.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.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
- 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<Integer>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService
-
Returns all available active case instances that match given statuses
- getCaseInstancesByDefinition(String, List<Integer>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService
-
Returns all available case instances;
- getCaseInstancesByDeployment(String, List<Integer>, QueryContext) - Method in interface org.jbpm.casemgmt.api.CaseRuntimeDataService
-
Returns all available case instances;
- getCaseInstancesOwnedBy(String, List<Integer>, 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.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
- 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.
- 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 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
- getIdentifierPrefix() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition
-
Returns case identifier prefix to be used for every instance of this case.
- 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.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 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.
- 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.
- 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)
- getVersion() - Method in interface org.jbpm.casemgmt.api.model.CaseDefinition
-
Returns version of this case