Package org.jbpm.casemgmt.api
Interface CaseRuntimeDataService
-
- All Known Implementing Classes:
CaseRuntimeDataServiceImpl
public interface CaseRuntimeDataServiceProvides access to case(s) and its runtime data such as:- available cases
- available milestones
- available stages
Note:
CaseInstance.getCaseFile()will always be empty when usingCaseRuntimeDataService. Refer to usingCaseService.getCaseFileInstance(String)when access to case file information is needed.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Collection<NodeInstanceDesc>getActiveNodesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)Returns active nodes in given case regardless in what process instance they belong to.Collection<AdHocFragment>getAdHocFragmentsForCase(String caseId)Returns list of AdHocFragments available in given case.Collection<CaseInstance>getAllDescendantSubCaseInstancesByParentCaseId(String parentCaseId, List<CaseStatus> statuses)Returns all subtree cases given an parent id case.CaseDefinitiongetCase(String deploymentId, String caseDefinitionId)Returns case definition identified by caseDefinitionId that belongs to given deploymentId.CaseInstancegetCaseInstanceById(String caseId)Returns case instance for given case id if the caller of this class is authorized to see the case instanceCollection<CaseFileItem>getCaseInstanceDataItems(String caseId, org.kie.api.runtime.query.QueryContext queryContext)Returns case file data items (as simple descriptions not actual values) for given case instanceCollection<CaseFileItem>getCaseInstanceDataItemsByName(String caseId, List<String> names, org.kie.api.runtime.query.QueryContext queryContext)Returns case file data items (as simple descriptions not actual values) for given case instance filtered by item namesCollection<CaseFileItem>getCaseInstanceDataItemsByType(String caseId, List<String> types, org.kie.api.runtime.query.QueryContext queryContext)Returns case file data items (as simple descriptions not actual values) for given case instance filtered by item typesCollection<CaseMilestoneInstance>getCaseInstanceMilestones(String caseId, boolean achievedOnly, org.kie.api.runtime.query.QueryContext queryContext)Returns milestones for given case instance, identified by case id.Collection<CaseInstance>getCaseInstances(boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instancesCollection<CaseInstance>getCaseInstances(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instances that match given statusesCollection<CaseInstance>getCaseInstances(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instances that match given statusesCollection<CaseInstance>getCaseInstances(org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instancesCollection<CaseInstance>getCaseInstancesAnyRole(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns case instances that given user (via identity provider) is involved in in any role.Collection<CaseInstance>getCaseInstancesAnyRole(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns case instances that given user (via identity provider) is involved in in any role.Collection<CaseInstance>getCaseInstancesByDataItem(String dataItemName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instances that match given statuses and has case file data item with given nameCollection<CaseInstance>getCaseInstancesByDataItem(String dataItemName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instances that match given statuses and has case file data item with given nameCollection<CaseInstance>getCaseInstancesByDataItemAndValue(String dataItemName, String dataItemValue, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instances that match given statuses and has case file data item with given name and valueCollection<CaseInstance>getCaseInstancesByDataItemAndValue(String dataItemName, String dataItemValue, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns all available active case instances that match given statuses and has case file data item with given name and valueCollection<CaseInstance>getCaseInstancesByDefinition(String caseDefinitionId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns all available case instances;Collection<CaseInstance>getCaseInstancesByDefinition(String caseDefinitionId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns all available case instances;Collection<CaseInstance>getCaseInstancesByDeployment(String deploymentId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns all available case instances;Collection<CaseInstance>getCaseInstancesByDeployment(String deploymentId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns all available case instances;Collection<CaseInstance>getCaseInstancesByRole(String roleName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns cases instances that given user (via identity provider) has access to with given role.Collection<CaseInstance>getCaseInstancesByRole(String roleName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns cases instances that given user (via identity provider) has access to with given role.Collection<CaseInstance>getCaseInstancesOwnedBy(String owner, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)Returns all case instances owned by given userCollection<CaseInstance>getCaseInstancesOwnedBy(String owner, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns all case instances owned by given userCollection<CaseStageInstance>getCaseInstanceStages(String caseId, boolean activeOnly, org.kie.api.runtime.query.QueryContext queryContext)Returns stages of given case instance, identified by case id.Collection<CaseDefinition>getCases(String filter, org.kie.api.runtime.query.QueryContext queryContext)Returns available cases which matching filter that applies to case name (usually represented by process id or name).Collection<CaseDefinition>getCases(org.kie.api.runtime.query.QueryContext queryContext)Returns available cases.Collection<CaseDefinition>getCasesByDeployment(String deploymentId, org.kie.api.runtime.query.QueryContext queryContext)Returns available cases for given deployment idList<org.kie.api.task.model.TaskSummary>getCaseTasksAssignedAsBusinessAdmin(String caseId, String userId, List<org.kie.api.task.model.Status> status, org.kie.api.runtime.query.QueryContext queryContext)Returns all tasks associated with given case id that are eligible for user to see as business admin role.List<org.kie.api.task.model.TaskSummary>getCaseTasksAssignedAsPotentialOwner(String caseId, String userId, List<org.kie.api.task.model.Status> status, org.kie.api.runtime.query.QueryContext queryContext)Returns all tasks associated with given case id that are eligible for user to see.List<org.kie.api.task.model.TaskSummary>getCaseTasksAssignedAsStakeholder(String caseId, String userId, List<org.kie.api.task.model.Status> status, org.kie.api.runtime.query.QueryContext queryContext)Returns all tasks associated with given case id that are eligible for user to see in task stakeholder role.Collection<NodeInstanceDesc>getCompletedNodesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)Returns completed nodes in given case regardless in what process instance they belong to.Collection<ProcessDefinition>getProcessDefinitions(String filter, org.kie.api.runtime.query.QueryContext queryContext)Returns process definitions that are not considered as case definitions and are filtered by process id or name.Collection<ProcessDefinition>getProcessDefinitions(org.kie.api.runtime.query.QueryContext queryContext)Returns process definitions that are not considered as case definitions.Collection<ProcessDefinition>getProcessDefinitionsByDeployment(String deploymentId, org.kie.api.runtime.query.QueryContext queryContext)Returns process definitions that are not considered as case definitions that belongs to given deployment.Collection<ProcessInstanceDesc>getProcessInstancesForCase(String caseId, List<Integer> processStates, org.kie.api.runtime.query.QueryContext queryContext)Returns process instances found for given case id.Collection<ProcessInstanceDesc>getProcessInstancesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)Returns process instances found for given case id.Collection<CaseInstance>getSubCaseInstancesByParentCaseId(String parentCaseId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)Returns all first level children cases given an parent id case.
-
-
-
Method Detail
-
getCase
CaseDefinition getCase(String deploymentId, String caseDefinitionId)
Returns case definition identified by caseDefinitionId that belongs to given deploymentId.- Parameters:
deploymentId- deployment identifier that case definition is part ofcaseDefinitionId- id of the case
-
getCases
Collection<CaseDefinition> getCases(org.kie.api.runtime.query.QueryContext queryContext)
Returns available cases.- Parameters:
queryContext- control parameters for the result e.g. sorting, paging
-
getCases
Collection<CaseDefinition> getCases(String filter, org.kie.api.runtime.query.QueryContext queryContext)
Returns available cases which matching filter that applies to case name (usually represented by process id or name).- Parameters:
filter- filter for case name to narrow down resultsqueryContext- control parameters for the result e.g. sorting, paging
-
getCasesByDeployment
Collection<CaseDefinition> getCasesByDeployment(String deploymentId, org.kie.api.runtime.query.QueryContext queryContext)
Returns available cases for given deployment id- Parameters:
deploymentId- deployment identifier that case definition is part ofqueryContext- control parameters for the result e.g. sorting, paging
-
getProcessDefinitions
Collection<ProcessDefinition> getProcessDefinitions(org.kie.api.runtime.query.QueryContext queryContext)
Returns process definitions that are not considered as case definitions.- Parameters:
queryContext- control parameters for the result e.g. sorting, paging
-
getProcessDefinitions
Collection<ProcessDefinition> getProcessDefinitions(String filter, org.kie.api.runtime.query.QueryContext queryContext)
Returns process definitions that are not considered as case definitions and are filtered by process id or name.- Parameters:
filter- regex based filter for either name or id of the processqueryContext- control parameters for the result e.g. sorting, paging
-
getProcessDefinitionsByDeployment
Collection<ProcessDefinition> getProcessDefinitionsByDeployment(String deploymentId, org.kie.api.runtime.query.QueryContext queryContext)
Returns process definitions that are not considered as case definitions that belongs to given deployment.- Parameters:
deploymentId- deployment id the processes should be found forqueryContext- control parameters for the result e.g. sorting, paging
-
getProcessInstancesForCase
Collection<ProcessInstanceDesc> getProcessInstancesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
Returns process instances found for given case id.- Parameters:
caseId- unique id of the casequeryContext- control parameters for the result e.g. sorting, paging
-
getProcessInstancesForCase
Collection<ProcessInstanceDesc> getProcessInstancesForCase(String caseId, List<Integer> processStates, org.kie.api.runtime.query.QueryContext queryContext)
Returns process instances found for given case id.- Parameters:
caseId- unique id of the caseprocessStates- states representing process instance (active, completed, aborted)queryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstanceMilestones
Collection<CaseMilestoneInstance> getCaseInstanceMilestones(String caseId, boolean achievedOnly, org.kie.api.runtime.query.QueryContext queryContext)
Returns milestones for given case instance, identified by case id.- Parameters:
caseId- unique id of the caseachievedOnly- filter option to return only these that have already been achievedqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstanceStages
Collection<CaseStageInstance> getCaseInstanceStages(String caseId, boolean activeOnly, org.kie.api.runtime.query.QueryContext queryContext)
Returns stages of given case instance, identified by case id.- Parameters:
caseId- unique id of the caseactiveOnly- filter option to return only stages that are activequeryContext- control parameters for the result e.g. sorting, paging
-
getActiveNodesForCase
Collection<NodeInstanceDesc> getActiveNodesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
Returns active nodes in given case regardless in what process instance they belong to.- Parameters:
caseId- unique id of the casequeryContext- control parameters for the result e.g. sorting, paging
-
getCompletedNodesForCase
Collection<NodeInstanceDesc> getCompletedNodesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
Returns completed nodes in given case regardless in what process instance they belong to.- Parameters:
caseId- unique id of the casequeryContext- control parameters for the result e.g. sorting, paging
-
getAdHocFragmentsForCase
Collection<AdHocFragment> getAdHocFragmentsForCase(String caseId)
Returns list of AdHocFragments available in given case. It includes all ad hoc fragments that are eligible for triggering - meaning it's container is active (case instance or stage)- Parameters:
caseId- unique id of the case
-
getCaseInstanceById
CaseInstance getCaseInstanceById(String caseId)
Returns case instance for given case id if the caller of this class is authorized to see the case instance- Parameters:
caseId- unique case id of the case- Returns:
- case instance with basic details or null in case it was not found or access was not granted
-
getCaseInstances
Collection<CaseInstance> getCaseInstances(org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances- Parameters:
queryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstances
Collection<CaseInstance> getCaseInstances(boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances- Parameters:
withData- indicates if case file data should be included in the resultqueryContext- control parameters for the result e.g. sorting, paging
-
getSubCaseInstancesByParentCaseId
Collection<CaseInstance> getSubCaseInstancesByParentCaseId(String parentCaseId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns all first level children cases given an parent id case.- Parameters:
parentCaseId- parent casestatuses- list of statuses that subcases should be in to matchqueryContext- control parameters for the result e.g. sorting, paging
-
getAllDescendantSubCaseInstancesByParentCaseId
Collection<CaseInstance> getAllDescendantSubCaseInstancesByParentCaseId(String parentCaseId, List<CaseStatus> statuses)
Returns all subtree cases given an parent id case.- Parameters:
parentCaseId- parent casestatuses- list of statuses that subcases should be in to match
-
getCaseInstances
Collection<CaseInstance> getCaseInstances(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances that match given statuses- Parameters:
statuses- list of statuses that case should be in to matchqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstances
Collection<CaseInstance> getCaseInstances(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances that match given statuses- Parameters:
statuses- list of statuses that case should be in to matchwithData- indicates if case file information should be included in returned instancesqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDeployment
Collection<CaseInstance> getCaseInstancesByDeployment(String deploymentId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available case instances;- Parameters:
deploymentId- deployment identifier that case instance is part ofstatuses- list of statuses that case should be in to matchqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDeployment
Collection<CaseInstance> getCaseInstancesByDeployment(String deploymentId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available case instances;- Parameters:
deploymentId- deployment identifier that case instance is part ofstatuses- list of statuses that case should be in to matchwithData- indicates if case file data should be included in the resultqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDefinition
Collection<CaseInstance> getCaseInstancesByDefinition(String caseDefinitionId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available case instances;- Parameters:
caseDefinitionId- case definition idstatuses- list of statuses that case should be in to matchqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDefinition
Collection<CaseInstance> getCaseInstancesByDefinition(String caseDefinitionId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available case instances;- Parameters:
caseDefinitionId- case definition idstatuses- list of statuses that case should be in to matchwithData- indicates if case file data should be included in the resultqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesOwnedBy
Collection<CaseInstance> getCaseInstancesOwnedBy(String owner, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns all case instances owned by given user- Parameters:
owner- user owning taskstatuses- list of statuses that case should be in to matchqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesOwnedBy
Collection<CaseInstance> getCaseInstancesOwnedBy(String owner, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns all case instances owned by given user- Parameters:
owner- user owning taskstatuses- list of statuses that case should be in to matchqueryContext- control parameters for the result e.g. sorting, pagingwithData- indicates if case file data should be included in the result
-
getCaseInstancesByRole
Collection<CaseInstance> getCaseInstancesByRole(String roleName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns cases instances that given user (via identity provider) has access to with given role.- Parameters:
roleName- name of the role that user should bestatuses- statuses of the case instancesqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByRole
Collection<CaseInstance> getCaseInstancesByRole(String roleName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns cases instances that given user (via identity provider) has access to with given role.- Parameters:
roleName- name of the role that user should bestatuses- statuses of the case instanceswithData- indicates if case file data should be included in the resultqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesAnyRole
Collection<CaseInstance> getCaseInstancesAnyRole(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns case instances that given user (via identity provider) is involved in in any role.- Parameters:
statuses- statuses of the case instancesqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesAnyRole
Collection<CaseInstance> getCaseInstancesAnyRole(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns case instances that given user (via identity provider) is involved in in any role.- Parameters:
statuses- statuses of the case instanceswithData- indicates if case file data should be included in the resultqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDataItem
Collection<CaseInstance> getCaseInstancesByDataItem(String dataItemName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances that match given statuses and has case file data item with given name- Parameters:
dataItemName- name of the case file data itemstatuses- list of statuses that case should be in to matchqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDataItem
Collection<CaseInstance> getCaseInstancesByDataItem(String dataItemName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances that match given statuses and has case file data item with given name- Parameters:
dataItemName- name of the case file data itemstatuses- list of statuses that case should be in to matchwithData- indicates if case file data should be included in the resultqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDataItemAndValue
Collection<CaseInstance> getCaseInstancesByDataItemAndValue(String dataItemName, String dataItemValue, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances that match given statuses and has case file data item with given name and value- Parameters:
dataItemName- name of the case file data itemdataItemValue- expected value of the data itemstatuses- list of statuses that case should be in to matchqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseInstancesByDataItemAndValue
Collection<CaseInstance> getCaseInstancesByDataItemAndValue(String dataItemName, String dataItemValue, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances that match given statuses and has case file data item with given name and value- Parameters:
dataItemName- name of the case file data itemdataItemValue- expected value of the data itemstatuses- list of statuses that case should be in to matchwithData- indicates if case file data should be included in the resultqueryContext- control parameters for the result e.g. sorting, paging
-
getCaseTasksAssignedAsPotentialOwner
List<org.kie.api.task.model.TaskSummary> getCaseTasksAssignedAsPotentialOwner(String caseId, String userId, List<org.kie.api.task.model.Status> status, org.kie.api.runtime.query.QueryContext queryContext)
Returns all tasks associated with given case id that are eligible for user to see.- Parameters:
caseId- unique id of the caseuserId- user id that the tasks should be available forstatus- status of the taskqueryContext- control parameters for the result e.g. sorting, paging- Returns:
- list of tasks found for given case id and user
-
getCaseTasksAssignedAsBusinessAdmin
List<org.kie.api.task.model.TaskSummary> getCaseTasksAssignedAsBusinessAdmin(String caseId, String userId, List<org.kie.api.task.model.Status> status, org.kie.api.runtime.query.QueryContext queryContext)
Returns all tasks associated with given case id that are eligible for user to see as business admin role.- Parameters:
caseId- unique id of the caseuserId- user id that the tasks should be available forstatus- status of the taskqueryContext- control parameters for the result e.g. sorting, paging- Returns:
- list of tasks found for given case id and user
-
getCaseTasksAssignedAsStakeholder
List<org.kie.api.task.model.TaskSummary> getCaseTasksAssignedAsStakeholder(String caseId, String userId, List<org.kie.api.task.model.Status> status, org.kie.api.runtime.query.QueryContext queryContext)
Returns all tasks associated with given case id that are eligible for user to see in task stakeholder role.- Parameters:
caseId- unique id of the caseuserId- user id that the tasks should be available forstatus- status of the taskqueryContext- control parameters for the result e.g. sorting, paging- Returns:
- list of tasks found for given case id and user
-
getCaseInstanceDataItems
Collection<CaseFileItem> getCaseInstanceDataItems(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
Returns case file data items (as simple descriptions not actual values) for given case instance- Parameters:
caseId- unique id of the casequeryContext- control parameters for the result e.g. sorting, paging- Returns:
- list of found case file data items
-
getCaseInstanceDataItemsByName
Collection<CaseFileItem> getCaseInstanceDataItemsByName(String caseId, List<String> names, org.kie.api.runtime.query.QueryContext queryContext)
Returns case file data items (as simple descriptions not actual values) for given case instance filtered by item names- Parameters:
caseId- unique id of the casenames- name of data items to be foundqueryContext- control parameters for the result e.g. sorting, paging- Returns:
- list of found case file data items
-
getCaseInstanceDataItemsByType
Collection<CaseFileItem> getCaseInstanceDataItemsByType(String caseId, List<String> types, org.kie.api.runtime.query.QueryContext queryContext)
Returns case file data items (as simple descriptions not actual values) for given case instance filtered by item types- Parameters:
caseId- unique id of the casetypes- type of data items to be foundqueryContext- control parameters for the result e.g. sorting, paging- Returns:
- list of found case file data items
-
-