|
jBPM distribution 6.2.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface RuntimeDataService
This service provides an interface to retrieve data about the runtime, including the following:
| Nested Class Summary | |
|---|---|
static class |
RuntimeDataService.EntryType
Represents type of node instance log entries. |
| Method Summary | |
|---|---|
NodeInstanceDesc |
getNodeInstanceForWorkItem(Long workItemId)
Returns active node instance descriptor for given work item id, if exists. |
ProcessDefinition |
getProcessById(String processId)
Returns process definition for given process id |
Collection<ProcessDefinition> |
getProcesses(org.kie.internal.query.QueryContext queryContext)
Returns all process definitions available |
Collection<ProcessDefinition> |
getProcessesByDeploymentId(String deploymentId,
org.kie.internal.query.QueryContext queryContext)
Returns list of process definitions for given deployment id |
ProcessDefinition |
getProcessesByDeploymentIdProcessId(String deploymentId,
String processId)
Returns process definition for given deployment and process identifiers |
Collection<ProcessDefinition> |
getProcessesByFilter(String filter,
org.kie.internal.query.QueryContext queryContext)
Returns list of process definitions that match the given filter |
Collection<String> |
getProcessIds(String deploymentId,
org.kie.internal.query.QueryContext queryContext)
Returns list of process definition identifiers for given deployment id |
ProcessInstanceDesc |
getProcessInstanceById(long processInstanceId)
Returns process instance descriptions found for given processInstanceId if found otherwise null. |
Collection<NodeInstanceDesc> |
getProcessInstanceFullHistory(long processInstanceId,
org.kie.internal.query.QueryContext queryContext)
Returns complete trace of all executed (completed) and active nodes for given process instance id |
Collection<NodeInstanceDesc> |
getProcessInstanceFullHistoryByType(long processInstanceId,
RuntimeDataService.EntryType type,
org.kie.internal.query.QueryContext queryContext)
Returns complete trace of all events of given type (START or END) for given process instance. |
Collection<NodeInstanceDesc> |
getProcessInstanceHistoryActive(long processInstanceId,
org.kie.internal.query.QueryContext queryContext)
Returns trace of all active nodes for given process instance id |
Collection<NodeInstanceDesc> |
getProcessInstanceHistoryCompleted(long processInstanceId,
org.kie.internal.query.QueryContext queryContext)
Returns trace of all executed (completed) for given process instance id |
Collection<ProcessInstanceDesc> |
getProcessInstances(List<Integer> states,
String initiator,
org.kie.internal.query.QueryContext queryContext)
Returns list of process instance descriptions found with given statuses and initiated by initiator. |
Collection<ProcessInstanceDesc> |
getProcessInstances(org.kie.internal.query.QueryContext queryContext)
Returns list of process instance descriptions |
Collection<ProcessInstanceDesc> |
getProcessInstancesByDeploymentId(String deploymentId,
List<Integer> states,
org.kie.internal.query.QueryContext queryContext)
Returns list of process instance descriptions found for given deployment id and statuses. |
Collection<ProcessInstanceDesc> |
getProcessInstancesByProcessDefinition(String processDefId,
org.kie.internal.query.QueryContext queryContext)
Returns list of process instance descriptions found for given process definition id |
Collection<ProcessInstanceDesc> |
getProcessInstancesByProcessId(List<Integer> states,
String processId,
String initiator,
org.kie.internal.query.QueryContext queryContext)
Returns list of process instance descriptions found for given process id and statuses and initiated by initiator |
Collection<ProcessInstanceDesc> |
getProcessInstancesByProcessName(List<Integer> states,
String processName,
String initiator,
org.kie.internal.query.QueryContext queryContext)
|
UserTaskInstanceDesc |
getTaskById(Long taskId)
Return a task by its taskId. |
UserTaskInstanceDesc |
getTaskByWorkItemId(Long workItemId)
Return a task by its workItemId. |
List<TaskSummary> |
getTasksAssignedAsBusinessAdministrator(String userId,
org.kie.internal.query.QueryFilter filter)
Return a list of assigned tasks as a Business Administrator. |
List<TaskSummary> |
getTasksAssignedAsPotentialOwner(String userId,
List<String> groupIds,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user or groups are eligible for with one of the listed statuses. |
List<TaskSummary> |
getTasksAssignedAsPotentialOwner(String userId,
List<String> groupIds,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user or groups are eligible for. |
List<TaskSummary> |
getTasksAssignedAsPotentialOwner(String userId,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user is eligible for. |
List<TaskSummary> |
getTasksAssignedAsPotentialOwnerByExpirationDateOptional(String userId,
List<Status> status,
Date from,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user is eligible for with one of the listed statuses and expiration date starting at from. |
List<TaskSummary> |
getTasksAssignedAsPotentialOwnerByStatus(String userId,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user is eligible for with one of the listed statuses. |
List<Long> |
getTasksByProcessInstanceId(Long processInstanceId)
Get a list of tasks the Process Instance is waiting on. |
List<TaskSummary> |
getTasksByStatusByProcessInstanceId(Long processInstanceId,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
Get a list of tasks the Process Instance is waiting on with one of the listed statuses. |
List<TaskSummary> |
getTasksOwned(String userId,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user has claimed. |
List<TaskSummary> |
getTasksOwnedByExpirationDateOptional(String userId,
List<Status> strStatuses,
Date from,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user has claimed with one of the listed statuses and expiration date starting at from. |
List<TaskSummary> |
getTasksOwnedByStatus(String userId,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
Return a list of tasks the user has claimed with one of the listed statuses. |
Collection<VariableDesc> |
getVariableHistory(long processInstanceId,
String variableId,
org.kie.internal.query.QueryContext queryContext)
Returns collection of changes to given variable within scope of process instance |
Collection<VariableDesc> |
getVariablesCurrentState(long processInstanceId)
Returns collections of all process variables current value for given process instance |
| Method Detail |
|---|
Collection<ProcessInstanceDesc> getProcessInstances(org.kie.internal.query.QueryContext queryContext)
queryContext - control parameters for the result e.g. sorting, paging
ProcessInstanceDesc instances representing the available process instances.
Collection<ProcessInstanceDesc> getProcessInstances(List<Integer> states,
String initiator,
org.kie.internal.query.QueryContext queryContext)
initiator.
states - A list of possible state (int) values that the ProcessInstance can have.initiator - The initiator of the ProcessInstance.queryContext - control parameters for the result e.g. sorting, paging
ProcessInstanceDesc instances representing the process instances that match
the given criteria (states and initiator).
Collection<ProcessInstanceDesc> getProcessInstancesByProcessId(List<Integer> states,
String processId,
String initiator,
org.kie.internal.query.QueryContext queryContext)
initiator
states - A list of possible state (int) values that the ProcessInstance can have.processId - The id of the Process (definition) used when starting the process instance.initiator - The initiator of the ProcessInstance.queryContext - control parameters for the result e.g. sorting, paging
ProcessInstanceDesc instances representing the process instances that match
the given criteria (states, processId, and initiator).
Collection<ProcessInstanceDesc> getProcessInstancesByProcessName(List<Integer> states,
String processName,
String initiator,
org.kie.internal.query.QueryContext queryContext)
states - A list of possible state (int) values that the ProcessInstance can have.processName - The name (not id!) of the Process (definition) used when starting the process instance.initiator - The initiator of the ProcessInstance.queryContext - control parameters for the result e.g. sorting, paging
ProcessInstanceDesc instances representing the process instances that match
the given criteria (states, processName and initiator).
Collection<ProcessInstanceDesc> getProcessInstancesByDeploymentId(String deploymentId,
List<Integer> states,
org.kie.internal.query.QueryContext queryContext)
deploymentId - The deployment id of the runtime.states - A list of possible state (int) values that the ProcessInstance can have.queryContext - control parameters for the result e.g. sorting, paging
ProcessInstanceDesc instances representing the process instances that match
the given criteria (deploymentId and states).ProcessInstanceDesc getProcessInstanceById(long processInstanceId)
processInstanceId - The id of the process instance to be fetched
ProcessInstanceDesc instance.
Collection<ProcessInstanceDesc> getProcessInstancesByProcessDefinition(String processDefId,
org.kie.internal.query.QueryContext queryContext)
processDefId - The id of the process (definition)queryContext - control parameters for the result e.g. sorting, paging
ProcessInstanceDesc instances representing the process instances that match
the given criteria (deploymentId and states).NodeInstanceDesc getNodeInstanceForWorkItem(Long workItemId)
workItemId - identifier of the work item
Collection<NodeInstanceDesc> getProcessInstanceHistoryActive(long processInstanceId,
org.kie.internal.query.QueryContext queryContext)
deploymentId - unique identifier of the deployment unitprocessInstanceId - unique identifier of process instancequeryContext - control parameters for the result e.g. sorting, paging
Collection<NodeInstanceDesc> getProcessInstanceHistoryCompleted(long processInstanceId,
org.kie.internal.query.QueryContext queryContext)
deploymentId - unique identifier of the deployment unitprocessInstanceId - unique identifier of process instancequeryContext - control parameters for the result e.g. sorting, paging
Collection<NodeInstanceDesc> getProcessInstanceFullHistory(long processInstanceId,
org.kie.internal.query.QueryContext queryContext)
deploymentId - The id of the deployment (runtime).processInstanceId - The id of the process used to start the process instance.queryContext - control parameters for the result e.g. sorting, paging
NodeInstance information, in the form of a list of NodeInstanceDesc instances,
that comes from a process instance that matches the given criteria (deploymentId, processId).
Collection<NodeInstanceDesc> getProcessInstanceFullHistoryByType(long processInstanceId,
RuntimeDataService.EntryType type,
org.kie.internal.query.QueryContext queryContext)
deploymentId - The id of the deployment (runtime).processInstanceId - The id of the process used to start the process instance.queryContext - control parameters for the result e.g. sorting, pagingtype - type of events that shall be returned (START or END) - to return both use #getProcessInstanceFullHistory(String, long)
Collection<VariableDesc> getVariablesCurrentState(long processInstanceId)
processInstanceId - The process instance id.
VariableStateDesc instances.
Collection<VariableDesc> getVariableHistory(long processInstanceId,
String variableId,
org.kie.internal.query.QueryContext queryContext)
processInstanceId - The process instance id.variableId - The id of the variablequeryContext - control parameters for the result e.g. sorting, paging
VariableStateDesc instances.
Collection<ProcessDefinition> getProcessesByDeploymentId(String deploymentId,
org.kie.internal.query.QueryContext queryContext)
deploymentId - The deployment id of the runtime.queryContext - control parameters for the result e.g. sorting, paging
ProcessAssetDesc instances representing processes that match
the given criteria (deploymentId)
Collection<ProcessDefinition> getProcessesByFilter(String filter,
org.kie.internal.query.QueryContext queryContext)
filter - A regular expression.queryContext - control parameters for the result e.g. sorting, paging
ProcessAssetDesc instances whose name or id matches the given regular expression.Collection<ProcessDefinition> getProcesses(org.kie.internal.query.QueryContext queryContext)
queryContext - control parameters for the result e.g. sorting, paging
ProcessAssetDesc instances.
Collection<String> getProcessIds(String deploymentId,
org.kie.internal.query.QueryContext queryContext)
deploymentId - The deployment id of the runtime.queryContext - control parameters for the result e.g. sorting, paging
ProcessDefinition getProcessById(String processId)
processId - The id of the process
ProcessAssetDesc instance, representing the Process
with the specified (process) id.
ProcessDefinition getProcessesByDeploymentIdProcessId(String deploymentId,
String processId)
deploymentId - The id of the deployment (runtime)processId - The id of the process
ProcessAssetDesc instance, representing the Process
that is present in the specified deployment with the specified (process) id.UserTaskInstanceDesc getTaskByWorkItemId(Long workItemId)
workItemId -
UserTaskInstanceDesc getTaskById(Long taskId)
taskId -
List<TaskSummary> getTasksAssignedAsBusinessAdministrator(String userId,
org.kie.internal.query.QueryFilter filter)
userId - filter -
List<TaskSummary> getTasksAssignedAsPotentialOwner(String userId,
org.kie.internal.query.QueryFilter filter)
userId - filter -
List<TaskSummary> getTasksAssignedAsPotentialOwner(String userId,
List<String> groupIds,
org.kie.internal.query.QueryFilter filter)
userId - groupIds - filter -
List<TaskSummary> getTasksAssignedAsPotentialOwnerByStatus(String userId,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
userId - status - filter -
List<TaskSummary> getTasksAssignedAsPotentialOwner(String userId,
List<String> groupIds,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
userId - groupIds - status - filter -
List<TaskSummary> getTasksAssignedAsPotentialOwnerByExpirationDateOptional(String userId,
List<Status> status,
Date from,
org.kie.internal.query.QueryFilter filter)
from. Tasks that do not have expiration date set
will also be included in the result set.
userId - status - from - filter -
List<TaskSummary> getTasksOwnedByExpirationDateOptional(String userId,
List<Status> strStatuses,
Date from,
org.kie.internal.query.QueryFilter filter)
from. Tasks that do not have expiration date set
will also be included in the result set.
userId - status - from - filter -
List<TaskSummary> getTasksOwned(String userId,
org.kie.internal.query.QueryFilter filter)
userId - filter -
List<TaskSummary> getTasksOwnedByStatus(String userId,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
userId - status - filter -
List<Long> getTasksByProcessInstanceId(Long processInstanceId)
processInstanceId -
List<TaskSummary> getTasksByStatusByProcessInstanceId(Long processInstanceId,
List<Status> status,
org.kie.internal.query.QueryFilter filter)
processInstanceId - status - filter -
|
jBPM distribution 6.2.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||