|
jBPM distribution 6.2.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ProcessService
| Method Summary | ||
|---|---|---|
void |
abortProcessInstance(Long processInstanceId)
Aborts the specified process |
|
void |
abortProcessInstances(List<Long> processInstanceIds)
Aborts all specified processes |
|
void |
abortWorkItem(Long id)
Abort the specified workItem |
|
void |
completeWorkItem(Long id,
Map<String,Object> results)
Completes the specified WorkItem with the given results |
|
|
execute(String deploymentId,
Command<T> command)
Executes provided command on the underlying command executor (usually KieSession) |
|
|
execute(String deploymentId,
Context<?> context,
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 |
|
ProcessInstance |
getProcessInstance(Long processInstanceId)
Returns process instance information. |
|
Object |
getProcessInstanceVariable(Long processInstanceId,
String variableName)
Gets a process instance's variable. |
|
Map<String,Object> |
getProcessInstanceVariables(Long processInstanceId)
Gets a process instance's variable values. |
|
WorkItem |
getWorkItem(Long id)
Returns the specified workItem |
|
List<WorkItem> |
getWorkItemByProcessInstance(Long processInstanceId)
Returns active work items by process instance id. |
|
void |
setProcessVariable(Long processInstanceId,
String variableId,
Object value)
Sets a process variable. |
|
void |
setProcessVariables(Long processInstanceId,
Map<String,Object> variables)
Sets process variables. |
|
void |
signalProcessInstance(Long processInstanceId,
String signalName,
Object event)
Signal an event to a single process instance |
|
void |
signalProcessInstances(List<Long> processInstanceIds,
String signalName,
Object event)
Signal an event to given list of process instances |
|
Long |
startProcess(String deploymentId,
String processId)
Starts a process with no variables |
|
Long |
startProcess(String deploymentId,
String processId,
Map<String,Object> params)
Starts a process with no variables |
|
| Method Detail |
|---|
Long startProcess(String deploymentId,
String processId)
deploymentId - deployment information for the process's kjarprocessId - The process's identifier
RuntimeException - in case of encountered errors
Long startProcess(String deploymentId,
String processId,
Map<String,Object> params)
deploymentId - deployment information for the process's kjarprocessId - The process's identifierparams - process variables
RuntimeException - in case of encountered errorsvoid abortProcessInstance(Long processInstanceId)
processInstanceId - process instance's unique identifier
DeploymentNotFoundException - in case deployment unit was not found
ProcessInstanceNotFoundException - in case process instance with given id was not foundvoid abortProcessInstances(List<Long> processInstanceIds)
processInstanceIds - list of process instance unique identifiers
DeploymentNotFoundException - in case deployment unit was not found
ProcessInstanceNotFoundException - in case process instance with given id was not found
void 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 event
DeploymentNotFoundException - in case deployment unit was not found
ProcessInstanceNotFoundException - in case process instance with given id was not found
void 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 event
DeploymentNotFoundException - in case deployment unit was not found
ProcessInstanceNotFoundException - in case process instance with given id was not foundProcessInstance getProcessInstance(Long processInstanceId)
processInstanceId - The process instance's unique identifier
DeploymentNotFoundException - in case deployment unit was not found
void setProcessVariable(Long processInstanceId,
String variableId,
Object value)
processInstanceId - The process instance's unique identifier.variableName - The variable name to set.variable - The variable value.
DeploymentNotFoundException - in case deployment unit was not found
ProcessInstanceNotFoundException - in case process instance with given id was not found
void 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 found
ProcessInstanceNotFoundException - in case process instance with given id was not found
Object 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 found
ProcessInstanceNotFoundException - 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 found
ProcessInstanceNotFoundException - in case process instance with given id was not foundCollection<String> getAvailableSignals(Long processInstanceId)
processInstanceId - process instance id
void completeWorkItem(Long id,
Map<String,Object> results)
id - workItem idresults - results of the workItem
DeploymentNotFoundException - in case deployment unit was not found
WorkItemNotFoundException - in case work item with given id was not foundvoid abortWorkItem(Long id)
id - workItem id
DeploymentNotFoundException - in case deployment unit was not found
WorkItemNotFoundException - in case work item with given id was not foundWorkItem getWorkItem(Long id)
id - workItem id
DeploymentNotFoundException - in case deployment unit was not found
WorkItemNotFoundException - in case work item with given id was not foundList<WorkItem> getWorkItemByProcessInstance(Long processInstanceId)
processInstanceId - process instance id
DeploymentNotFoundException - in case deployment unit was not found
ProcessInstanceNotFoundException - in case process instance with given id was not found
<T> T execute(String deploymentId,
Command<T> command)
deploymentId - deployment information for the process's kjarcommand - actual command for execution
DeploymentNotFoundException - in case deployment unit was not found
<T> T execute(String deploymentId,
Context<?> context,
Command<T> command)
deploymentId - deployment information for the process's kjarcontext - context implementation to be used to get runtime enginecommand - actual command for execution
DeploymentNotFoundException - in case deployment unit was not found
|
jBPM distribution 6.2.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||