public interface CaseRuntimeDataService
Note: CaseInstance.getCaseFile()
will always be empty when using CaseRuntimeDataService
.
Refer to using CaseService.getCaseFileInstance(String)
when access to case file information is needed.
Modifier and Type | Method and Description |
---|---|
Collection<org.jbpm.services.api.model.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.
|
CaseDefinition |
getCase(String deploymentId,
String caseDefinitionId)
Returns case definition identified by caseDefinitionId that belongs to given deploymentId.
|
CaseInstance |
getCaseInstanceById(String caseId)
Returns case instance for given case id if the caller of this class is authorized to see the case instance
|
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
|
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
|
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
|
Collection<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(List<CaseStatus> statuses,
org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances that match given statuses
|
Collection<CaseInstance> |
getCaseInstances(org.kie.api.runtime.query.QueryContext queryContext)
Returns all available active case instances
|
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,
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
|
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
|
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,
org.kie.api.runtime.query.QueryContext queryContext)
Returns all available case instances;
|
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,
org.kie.api.runtime.query.QueryContext queryContext)
Returns all case instances owned by given user
|
Collection<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(org.kie.api.runtime.query.QueryContext queryContext)
Returns available cases.
|
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> |
getCasesByDeployment(String deploymentId,
org.kie.api.runtime.query.QueryContext queryContext)
Returns available cases for given deployment id
|
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.
|
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<org.jbpm.services.api.model.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<org.jbpm.services.api.model.ProcessDefinition> |
getProcessDefinitions(org.kie.api.runtime.query.QueryContext queryContext)
Returns process definitions that are not considered as case definitions.
|
Collection<org.jbpm.services.api.model.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<org.jbpm.services.api.model.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<org.jbpm.services.api.model.ProcessInstanceDesc> |
getProcessInstancesForCase(String caseId,
List<Integer> processStates,
org.kie.api.runtime.query.QueryContext queryContext)
Returns process instances found for given case id.
|
Collection<org.jbpm.services.api.model.ProcessInstanceDesc> |
getProcessInstancesForCase(String caseId,
org.kie.api.runtime.query.QueryContext queryContext)
Returns process instances found for given case id.
|
CaseDefinition getCase(String deploymentId, String caseDefinitionId)
deploymentId
- deployment identifier that case definition is part ofcaseDefinitionId
- id of the caseCollection<CaseDefinition> getCases(org.kie.api.runtime.query.QueryContext queryContext)
queryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseDefinition> getCases(String filter, org.kie.api.runtime.query.QueryContext queryContext)
filter
- filter for case name to narrow down resultsqueryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseDefinition> getCasesByDeployment(String deploymentId, org.kie.api.runtime.query.QueryContext queryContext)
deploymentId
- deployment identifier that case definition is part ofqueryContext
- control parameters for the result e.g. sorting, pagingCollection<org.jbpm.services.api.model.ProcessDefinition> getProcessDefinitions(org.kie.api.runtime.query.QueryContext queryContext)
queryContext
- control parameters for the result e.g. sorting, pagingCollection<org.jbpm.services.api.model.ProcessDefinition> getProcessDefinitions(String filter, org.kie.api.runtime.query.QueryContext queryContext)
filter
- regex based filter for either name or id of the processqueryContext
- control parameters for the result e.g. sorting, pagingCollection<org.jbpm.services.api.model.ProcessDefinition> getProcessDefinitionsByDeployment(String deploymentId, org.kie.api.runtime.query.QueryContext queryContext)
deploymentId
- deployment id the processes should be found forqueryContext
- control parameters for the result e.g. sorting, pagingCollection<org.jbpm.services.api.model.ProcessInstanceDesc> getProcessInstancesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the casequeryContext
- control parameters for the result e.g. sorting, pagingCollection<org.jbpm.services.api.model.ProcessInstanceDesc> getProcessInstancesForCase(String caseId, List<Integer> processStates, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the caseprocessStates
- states representing process instance (active, completed, aborted)queryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseMilestoneInstance> getCaseInstanceMilestones(String caseId, boolean achievedOnly, org.kie.api.runtime.query.QueryContext queryContext)
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, pagingCollection<CaseStageInstance> getCaseInstanceStages(String caseId, boolean activeOnly, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the caseactiveOnly
- filter option to return only stages that are activequeryContext
- control parameters for the result e.g. sorting, pagingCollection<org.jbpm.services.api.model.NodeInstanceDesc> getActiveNodesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the casequeryContext
- control parameters for the result e.g. sorting, pagingCollection<org.jbpm.services.api.model.NodeInstanceDesc> getCompletedNodesForCase(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the casequeryContext
- control parameters for the result e.g. sorting, pagingCollection<AdHocFragment> getAdHocFragmentsForCase(String caseId)
caseId
- unique id of the caseCaseInstance getCaseInstanceById(String caseId)
caseId
- unique case id of the caseCollection<CaseInstance> getCaseInstances(org.kie.api.runtime.query.QueryContext queryContext)
queryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseInstance> getCaseInstances(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
statuses
- list of statuses that case should be in to matchqueryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseInstance> getCaseInstancesByDeployment(String deploymentId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
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, pagingCollection<CaseInstance> getCaseInstancesByDefinition(String caseDefinitionId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
caseDefinitionId
- case definition idstatuses
- list of statuses that case should be in to matchqueryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseInstance> getCaseInstancesOwnedBy(String owner, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
statuses
- list of statuses that case should be in to matchqueryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseInstance> getCaseInstancesByRole(String roleName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
roleName
- name of the role that user should bestatuses
- statuses of the case instancesqueryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseInstance> getCaseInstancesAnyRole(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
statuses
- statuses of the case instancesqueryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseInstance> getCaseInstancesByDataItem(String dataItemName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
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, pagingCollection<CaseInstance> getCaseInstancesByDataItemAndValue(String dataItemName, String dataItemValue, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)
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, pagingList<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)
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, pagingList<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)
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, pagingList<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)
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, pagingCollection<CaseFileItem> getCaseInstanceDataItems(String caseId, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the casequeryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseFileItem> getCaseInstanceDataItemsByName(String caseId, List<String> names, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the casenames
- name of data items to be foundqueryContext
- control parameters for the result e.g. sorting, pagingCollection<CaseFileItem> getCaseInstanceDataItemsByType(String caseId, List<String> types, org.kie.api.runtime.query.QueryContext queryContext)
caseId
- unique id of the casetypes
- type of data items to be foundqueryContext
- control parameters for the result e.g. sorting, pagingCopyright © 2001–2019 JBoss by Red Hat. All rights reserved.