public interface ProcessService
| Modifier and Type | Method and Description |
|---|---|
void |
abortProcessInstance(Long processInstanceId)
Aborts the specified process
|
void |
abortProcessInstance(String deploymentId,
Long processInstanceId)
Aborts the specified process
|
void |
abortProcessInstances(List<Long> processInstanceIds)
Aborts all specified processes
|
void |
abortProcessInstances(String deploymentId,
List<Long> processInstanceIds)
Aborts all specified processes
|
void |
abortWorkItem(Long id)
Abort the specified workItem
|
void |
abortWorkItem(String deploymentId,
Long processInstanceId,
Long id)
Abort the specified workItem
|
void |
completeWorkItem(Long id,
Map<String,Object> results)
Completes the specified WorkItem with the given results
|
void |
completeWorkItem(String deploymentId,
Long processInstanceId,
Long id,
Map<String,Object> results)
Completes the specified WorkItem with the given results
|
Map<String,Object> |
computeProcessOutcome(String deploymentId,
String processId,
Map<String,Object> params)
compute the process outcome for those process designed to start and finish in the same transaction.
|
<T> T |
execute(String deploymentId,
org.kie.api.command.Command<T> command)
Executes provided command on the underlying command executor (usually KieSession)
|
<T> T |
execute(String deploymentId,
org.kie.api.runtime.manager.Context<?> context,
org.kie.api.command.Command<T> command)
Executes provided command on the underlying command executor (usually KieSession)
|
Collection<String> |
getAvailableSignals(Long processInstanceId)
Returns all signals available in current state of given process instance
|
Collection<String> |
getAvailableSignals(String deploymentId,
Long processInstanceId)
Returns all signals available in current state of given process instance
|
org.kie.api.runtime.process.ProcessInstance |
getProcessInstance(org.kie.internal.process.CorrelationKey correlationKey)
Returns process instance information.
|
org.kie.api.runtime.process.ProcessInstance |
getProcessInstance(Long processInstanceId)
Returns process instance information.
|
org.kie.api.runtime.process.ProcessInstance |
getProcessInstance(String deploymentId,
org.kie.internal.process.CorrelationKey correlationKey)
Returns process instance information.
|
org.kie.api.runtime.process.ProcessInstance |
getProcessInstance(String deploymentId,
Long processInstanceId)
Returns process instance information.
|
Object |
getProcessInstanceVariable(Long processInstanceId,
String variableName)
Gets a process instance's variable.
|
Object |
getProcessInstanceVariable(String deploymentId,
Long processInstanceId,
String variableName)
Gets a process instance's variable.
|
Map<String,Object> |
getProcessInstanceVariables(Long processInstanceId)
Gets a process instance's variable values.
|
Map<String,Object> |
getProcessInstanceVariables(String deploymentId,
Long processInstanceId)
Gets a process instance's variable values.
|
org.kie.api.runtime.process.WorkItem |
getWorkItem(Long id)
Returns the specified workItem
|
org.kie.api.runtime.process.WorkItem |
getWorkItem(String deploymentId,
Long processInstanceId,
Long id)
Returns the specified workItem
|
List<org.kie.api.runtime.process.WorkItem> |
getWorkItemByProcessInstance(Long processInstanceId)
Returns active work items by process instance id.
|
List<org.kie.api.runtime.process.WorkItem> |
getWorkItemByProcessInstance(String deploymentId,
Long processInstanceId)
Returns active work items by process instance id.
|
void |
setProcessVariable(Long processInstanceId,
String variableId,
Object value)
Sets a process variable.
|
void |
setProcessVariable(String deploymentId,
Long processInstanceId,
String variableId,
Object value)
Sets a process variable.
|
void |
setProcessVariables(Long processInstanceId,
Map<String,Object> variables)
Sets process variables.
|
void |
setProcessVariables(String deploymentId,
Long processInstanceId,
Map<String,Object> variables)
Sets process variables.
|
void |
signalEvent(String deployment,
String signalName,
Object event)
Signal an event to a any process instance that listens to give signal that belongs to given deployment
|
void |
signalProcessInstance(Long processInstanceId,
String signalName,
Object event)
Signal an event to a single process instance
|
void |
signalProcessInstance(String deploymentId,
Long processInstanceId,
String signalName,
Object event)
Signal an event to a single process instance
|
void |
signalProcessInstanceByCorrelationKey(org.kie.internal.process.CorrelationKey correlationKey,
String signalName,
Object event)
Signal an event to a single process instance by correlation key
|
void |
signalProcessInstanceByCorrelationKey(String deploymentId,
org.kie.internal.process.CorrelationKey correlationKey,
String signalName,
Object event)
Signal an event to a single process instance by correlation key
|
void |
signalProcessInstances(List<Long> processInstanceIds,
String signalName,
Object event)
Signal an event to given list of process instances
|
void |
signalProcessInstances(String deploymentId,
List<Long> processInstanceIds,
String signalName,
Object event)
Signal an event to given list of process instances
|
void |
signalProcessInstancesByCorrelationKeys(List<org.kie.internal.process.CorrelationKey> correlationKeys,
String signalName,
Object event)
Signal an event to given list of correlation keys
|
void |
signalProcessInstancesByCorrelationKeys(String deploymentId,
List<org.kie.internal.process.CorrelationKey> correlationKeys,
String signalName,
Object event)
Signal an event to given list of correlation keys
|
Long |
startProcess(String deploymentId,
String processId)
Starts a process with no variables
|
Long |
startProcess(String deploymentId,
String processId,
org.kie.internal.process.CorrelationKey correlationKey)
Starts a process with no variables
|
Long |
startProcess(String deploymentId,
String processId,
org.kie.internal.process.CorrelationKey correlationKey,
Map<String,Object> params)
Starts a process with no variables
|
Long |
startProcess(String deploymentId,
String processId,
Map<String,Object> params)
Starts a process with no variables
|
Long |
startProcessFromNodeIds(String deploymentId,
String processId,
org.kie.internal.process.CorrelationKey key,
Map<String,Object> params,
String... nodeIds)
Starts a process with the values supplied from the current nodes
|
Long |
startProcessFromNodeIds(String deploymentId,
String processId,
Map<String,Object> params,
String... nodeIds)
Starts a process with the values supplied from the current nodes
|
Long startProcess(String deploymentId, String processId)
deploymentId - deployment information for the process's kjarprocessId - The process's identifierRuntimeException - in case of encountered errorsDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not activeLong startProcess(String deploymentId, String processId, Map<String,Object> params)
deploymentId - deployment information for the process's kjarprocessId - The process's identifierparams - process variablesRuntimeException - in case of encountered errorsDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not activeMap<String,Object> computeProcessOutcome(String deploymentId, String processId, Map<String,Object> params)
deploymentId - deployment information for the process's kjarprocessId - the process identifierparams - process variablesLong startProcess(String deploymentId, String processId, org.kie.internal.process.CorrelationKey correlationKey)
deploymentId - deployment information for the process's kjarprocessId - The process's identifiercorrelationKey - correlation key to be assigned to process instance - must be uniqueRuntimeException - in case of encountered errorsDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not activeLong startProcess(String deploymentId, String processId, org.kie.internal.process.CorrelationKey correlationKey, Map<String,Object> params)
deploymentId - deployment information for the process's kjarprocessId - The process's identifiercorrelationKey - correlation key to be assigned to process instance - must be uniqueparams - process variablesRuntimeException - in case of encountered errorsDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not activeLong startProcessFromNodeIds(String deploymentId, String processId, Map<String,Object> params, String... nodeIds)
deploymentId - deployment information for the process's kjarprocessId - The process's identifierparams - process variablesnodeIds - list of bpmn node id list where the process is going to startRuntimeException - in case of encountered errorsDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not activeLong startProcessFromNodeIds(String deploymentId, String processId, org.kie.internal.process.CorrelationKey key, Map<String,Object> params, String... nodeIds)
deploymentId - deployment information for the process's kjarprocessId - The process's identifierkey - correlation key (must be unique)params - process variablesnodeIds - list of bpmn node id list where the process is going to start.RuntimeException - in case of encountered errorsDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not activevoid abortProcessInstance(Long processInstanceId)
processInstanceId - process instance's unique identifierDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid abortProcessInstance(String deploymentId, Long processInstanceId)
deploymentId - deployment that process instance belongs toprocessInstanceId - process instance's unique identifierDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid abortProcessInstances(List<Long> processInstanceIds)
processInstanceIds - list of process instance unique identifiersDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid abortProcessInstances(String deploymentId, List<Long> processInstanceIds)
deploymentId - deployment that process instance belongs toprocessInstanceIds - list of process instance unique identifiersDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstance(Long processInstanceId, String signalName, Object event)
processInstanceId - the process instance's unique identifiersignalName - the signal's id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstance(String deploymentId, Long processInstanceId, String signalName, Object event)
deploymentId - deployment that process instance belongs toprocessInstanceId - the process instance's unique identifiersignalName - the signal's id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstances(List<Long> processInstanceIds, String signalName, Object event)
processInstanceIds - list of process instance unique identifierssignalName - the signal's id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstances(String deploymentId, List<Long> processInstanceIds, String signalName, Object event)
deploymentId - deployment that process instance belongs toprocessInstanceIds - list of process instance unique identifierssignalName - the signal's id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstanceByCorrelationKey(org.kie.internal.process.CorrelationKey correlationKey,
String signalName,
Object event)
correlationKey - the process instances unique correlation keysignalName - the signals id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstanceByCorrelationKey(String deploymentId, org.kie.internal.process.CorrelationKey correlationKey, String signalName, Object event)
deploymentId - deployment that process instance belongs tocorrelationKey - the process instances unique correlation keysignalName - the signals id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstancesByCorrelationKeys(List<org.kie.internal.process.CorrelationKey> correlationKeys, String signalName, Object event)
correlationKeys - list of process instance unique correlation keyssignalName - the signal's id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalProcessInstancesByCorrelationKeys(String deploymentId, List<org.kie.internal.process.CorrelationKey> correlationKeys, String signalName, Object event)
deploymentId - deployment that process instance belongs tocorrelationKeys - list of process instance unique correlation keyssignalName - the signal's id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid signalEvent(String deployment, String signalName, Object event)
deployment - information for the process's kjarsignalName - the signal's id in the processevent - the event object to be passed in with the eventDeploymentNotFoundException - in case deployment unit was not foundorg.kie.api.runtime.process.ProcessInstance getProcessInstance(Long processInstanceId)
processInstanceId - The process instance's unique identifierDeploymentNotFoundException - in case deployment unit was not foundorg.kie.api.runtime.process.ProcessInstance getProcessInstance(String deploymentId, Long processInstanceId)
deploymentId - deployment that process instance belongs toprocessInstanceId - The process instance's unique identifierDeploymentNotFoundException - in case deployment unit was not foundorg.kie.api.runtime.process.ProcessInstance getProcessInstance(org.kie.internal.process.CorrelationKey correlationKey)
correlationKey - correlation key assigned to process instanceDeploymentNotFoundException - in case deployment unit was not foundorg.kie.api.runtime.process.ProcessInstance getProcessInstance(String deploymentId, org.kie.internal.process.CorrelationKey correlationKey)
deploymentId - deployment that process instance belongs tocorrelationKey - correlation key assigned to process instanceDeploymentNotFoundException - in case deployment unit was not foundvoid setProcessVariable(Long processInstanceId, String variableId, Object value)
processInstanceId - The process instance's unique identifier.variableId - The variable id to set.value - The variable value.DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid setProcessVariable(String deploymentId, Long processInstanceId, String variableId, Object value)
deploymentId - deployment that process instance belongs toprocessInstanceId - The process instance's unique identifier.variableId - The variable id to set.value - The variable value.DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid setProcessVariables(Long processInstanceId, Map<String,Object> variables)
processInstanceId - The process instance's unique identifier.variables - map of process variables (key - variable name, value - variable value)DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundvoid setProcessVariables(String deploymentId, Long processInstanceId, Map<String,Object> variables)
deploymentId - deployment that process instance belongs toprocessInstanceId - The process instance's unique identifier.variables - map of process variables (key - variable name, value - variable value)DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundObject getProcessInstanceVariable(Long processInstanceId, String variableName)
processInstanceId - the process instance's unique identifier.variableName - the variable name to get from the process.DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundObject getProcessInstanceVariable(String deploymentId, Long processInstanceId, String variableName)
deploymentId - deployment that process instance belongs toprocessInstanceId - the process instance's unique identifier.variableName - the variable name to get from the process.DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundMap<String,Object> getProcessInstanceVariables(Long processInstanceId)
processInstanceId - The process instance's unique identifier.DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundMap<String,Object> getProcessInstanceVariables(String deploymentId, Long processInstanceId)
deploymentId - deployment that process instance belongs toprocessInstanceId - The process instance's unique identifier.DeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundCollection<String> getAvailableSignals(Long processInstanceId)
processInstanceId - process instance idCollection<String> getAvailableSignals(String deploymentId, Long processInstanceId)
deploymentId - deployment that process instance belongs toprocessInstanceId - process instance idvoid completeWorkItem(Long id, Map<String,Object> results)
id - workItem idresults - results of the workItemDeploymentNotFoundException - in case deployment unit was not foundWorkItemNotFoundException - in case work item with given id was not foundvoid completeWorkItem(String deploymentId, Long processInstanceId, Long id, Map<String,Object> results)
deploymentId - deployment that process instance belongs toprocessInstanceId - process instance id that work item belongs toid - workItem idresults - results of the workItemDeploymentNotFoundException - in case deployment unit was not foundWorkItemNotFoundException - in case work item with given id was not foundvoid abortWorkItem(Long id)
id - workItem idDeploymentNotFoundException - in case deployment unit was not foundWorkItemNotFoundException - in case work item with given id was not foundvoid abortWorkItem(String deploymentId, Long processInstanceId, Long id)
deploymentId - deployment that process instance belongs toprocessInstanceId - process instance id that work item belongs toid - workItem idDeploymentNotFoundException - in case deployment unit was not foundWorkItemNotFoundException - in case work item with given id was not foundorg.kie.api.runtime.process.WorkItem getWorkItem(Long id)
id - workItem idDeploymentNotFoundException - in case deployment unit was not foundWorkItemNotFoundException - in case work item with given id was not foundorg.kie.api.runtime.process.WorkItem getWorkItem(String deploymentId, Long processInstanceId, Long id)
deploymentId - deployment that process instance belongs toprocessInstanceId - process instance id that work item belongs toid - workItem idDeploymentNotFoundException - in case deployment unit was not foundWorkItemNotFoundException - in case work item with given id was not foundList<org.kie.api.runtime.process.WorkItem> getWorkItemByProcessInstance(Long processInstanceId)
processInstanceId - process instance idDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not foundList<org.kie.api.runtime.process.WorkItem> getWorkItemByProcessInstance(String deploymentId, Long processInstanceId)
deploymentId - deployment that process instance belongs toprocessInstanceId - process instance idDeploymentNotFoundException - in case deployment unit was not foundProcessInstanceNotFoundException - in case process instance with given id was not found<T> T execute(String deploymentId, org.kie.api.command.Command<T> command)
deploymentId - deployment information for the process's kjarcommand - actual command for executionDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not active for restricted commands (e.g. start process)<T> T execute(String deploymentId, org.kie.api.runtime.manager.Context<?> context, org.kie.api.command.Command<T> command)
deploymentId - deployment information for the process's kjarcontext - context implementation to be used to get runtime enginecommand - actual command for executionDeploymentNotFoundException - in case deployment with given deployment id does not existDeploymentNotActiveException - in case deployment with given deployment id is not active for restricted commands (e.g. start process)Copyright © 2001–2021 JBoss by Red Hat. All rights reserved.