org.ow2.bonita.pvm
Interface ExecutionService

All Known Implementing Classes:
CommandExecutionService

public interface ExecutionService

manages runtime process executions.

Author:
Tom Baeyens

Method Summary
 Execution findExecution(java.lang.String executionId)
          the execution that is uniquely defined by the process definition and the business key.
 Execution findExecution(java.lang.String processDefinitionName, java.lang.String executionKey)
          the execution that is uniquely defined by the process definition and the business key.
 java.lang.Object getVariable(java.lang.String executionId, java.lang.String variableName)
          retrieves a variable
 java.util.Map<java.lang.String,java.lang.Object> getVariables(java.lang.String executionId, java.util.List<java.lang.String> variableNames)
          retrieves a map of variables
 Execution setVariable(java.lang.String executionId, java.lang.String name, java.lang.Object value)
          creates or overwrites a variable value on the referenced execution
 Execution setVariables(java.lang.String executionId, java.util.Map<java.lang.String,java.lang.Object> variables)
          creates or overwrites the variable values on the referenced execution
 Execution signalExecution(java.lang.String executionId)
          provides an external trigger to an execution.
 Execution signalExecution(java.lang.String executionId, java.util.Map<java.lang.String,java.lang.Object> parameters)
          provides a external trigger to an execution with parameters.
 Execution signalExecution(java.lang.String executionId, java.lang.String signalName)
          provides a named external trigger to an execution.
 Execution signalExecution(java.lang.String executionId, java.lang.String signalName, java.util.Map<java.lang.String,java.lang.Object> parameters)
          provides a named external trigger to an execution with parameters.
 Execution signalExecutionByKey(java.lang.String processDefinitionName, java.lang.String executionKey)
          provides a named external trigger to an execution.
 Execution signalExecutionByKey(java.lang.String processDefinitionName, java.lang.String executionKey, java.util.Map<java.lang.String,java.lang.Object> parameters)
          provides a named external trigger to an execution with parameters.
 Execution signalExecutionByKey(java.lang.String processDefinitionName, java.lang.String executionKey, java.lang.String signalName)
          provides a named external trigger to an execution.
 Execution signalExecutionByKey(java.lang.String processDefinitionName, java.lang.String executionKey, java.lang.String signalName, java.util.Map<java.lang.String,java.lang.Object> parameters)
          provides a named external trigger to an execution with parameters.
 Execution startExecution(java.lang.String processDefinitionId)
          starts a new execution for the ProcessDefinition with the given processDefinitionDbid.
 Execution startExecution(java.lang.String processDefinitionId, java.util.Map<java.lang.String,java.lang.Object> variables)
          starts a new execution for the ProcessDefinition with the given processDefinitionDbid.
 Execution startExecution(java.lang.String processDefinitionId, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.String executionKey)
          starts a new execution for the ProcessDefinition with the given processDefinitionDbid.
 Execution startExecution(java.lang.String processDefinitionId, java.lang.String executionKey)
          starts a new execution for the ProcessDefinition with the given processDefinitionDbid.
 Execution startExecutionInLatest(java.lang.String processDefinitionName)
          starts a new execution in the latest version of the given process definition.
 Execution startExecutionInLatest(java.lang.String processDefinitionName, java.util.Map<java.lang.String,java.lang.Object> variables)
          starts a new execution in the latest version of the given processDefinitionName.
 Execution startExecutionInLatest(java.lang.String processDefinitionName, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.String executionKey)
          starts a new execution in the latest version of the given processDefinitionName.
 Execution startExecutionInLatest(java.lang.String processDefinitionName, java.lang.String executionKey)
          starts a new execution in the latest version of the given processDefinitionName.
 

Method Detail

startExecution

Execution startExecution(java.lang.String processDefinitionId)
starts a new execution for the ProcessDefinition with the given processDefinitionDbid.

Parameters:
processDefinitionId - the unique id of the process definition.

startExecution

Execution startExecution(java.lang.String processDefinitionId,
                         java.lang.String executionKey)
starts a new execution for the ProcessDefinition with the given processDefinitionDbid.

Parameters:
processDefinitionId - the unique id of the process definition.
executionKey - is a user provided reference for the new execution that must be unique over all process versions with the same name.

startExecution

Execution startExecution(java.lang.String processDefinitionId,
                         java.util.Map<java.lang.String,java.lang.Object> variables)
starts a new execution for the ProcessDefinition with the given processDefinitionDbid.

Parameters:
processDefinitionId - the unique id of the process definition.
variables - are the initial values of the process variables that will be set before the execution starts.

startExecution

Execution startExecution(java.lang.String processDefinitionId,
                         java.util.Map<java.lang.String,java.lang.Object> variables,
                         java.lang.String executionKey)
starts a new execution for the ProcessDefinition with the given processDefinitionDbid.

Parameters:
processDefinitionId - the unique id of the process definition.
variables - are the initial values of the process variables that will be set before the execution starts.
executionKey - is a user provided reference for the new execution that must be unique over all process versions with the same name.

startExecutionInLatest

Execution startExecutionInLatest(java.lang.String processDefinitionName)
starts a new execution in the latest version of the given process definition.

Parameters:
processDefinitionName - is the name of the process definition for which the latest version will be taken.

startExecutionInLatest

Execution startExecutionInLatest(java.lang.String processDefinitionName,
                                 java.lang.String executionKey)
starts a new execution in the latest version of the given processDefinitionName.

Parameters:
processDefinitionName - is the name of the process definition for which the latest version will be taken.
executionKey - is a user provided reference for the new execution that must be unique over all process versions with the same name.

startExecutionInLatest

Execution startExecutionInLatest(java.lang.String processDefinitionName,
                                 java.util.Map<java.lang.String,java.lang.Object> variables)
starts a new execution in the latest version of the given processDefinitionName.

Parameters:
processDefinitionName - is the name of the process definition for which the latest version will be taken.
variables - are the initial values of the process variables that will be set before the execution starts (read: before the initial node is executed).

startExecutionInLatest

Execution startExecutionInLatest(java.lang.String processDefinitionName,
                                 java.util.Map<java.lang.String,java.lang.Object> variables,
                                 java.lang.String executionKey)
starts a new execution in the latest version of the given processDefinitionName.

Parameters:
processDefinitionName - is the name of the process definition for which the latest version will be taken.
variables - are the initial values of the process variables that will be set before the execution starts.
executionKey - is a user provided reference for the new execution that must be unique over all process versions with the same name.

findExecution

Execution findExecution(java.lang.String processDefinitionName,
                        java.lang.String executionKey)
the execution that is uniquely defined by the process definition and the business key.


findExecution

Execution findExecution(java.lang.String executionId)
the execution that is uniquely defined by the process definition and the business key.


signalExecution

Execution signalExecution(java.lang.String executionId)
provides an external trigger to an execution.


signalExecution

Execution signalExecution(java.lang.String executionId,
                          java.lang.String signalName)
provides a named external trigger to an execution.


signalExecution

Execution signalExecution(java.lang.String executionId,
                          java.lang.String signalName,
                          java.util.Map<java.lang.String,java.lang.Object> parameters)
provides a named external trigger to an execution with parameters.


signalExecution

Execution signalExecution(java.lang.String executionId,
                          java.util.Map<java.lang.String,java.lang.Object> parameters)
provides a external trigger to an execution with parameters.


signalExecutionByKey

Execution signalExecutionByKey(java.lang.String processDefinitionName,
                               java.lang.String executionKey)
provides a named external trigger to an execution.


signalExecutionByKey

Execution signalExecutionByKey(java.lang.String processDefinitionName,
                               java.lang.String executionKey,
                               java.lang.String signalName)
provides a named external trigger to an execution.


signalExecutionByKey

Execution signalExecutionByKey(java.lang.String processDefinitionName,
                               java.lang.String executionKey,
                               java.util.Map<java.lang.String,java.lang.Object> parameters)
provides a named external trigger to an execution with parameters.


signalExecutionByKey

Execution signalExecutionByKey(java.lang.String processDefinitionName,
                               java.lang.String executionKey,
                               java.lang.String signalName,
                               java.util.Map<java.lang.String,java.lang.Object> parameters)
provides a named external trigger to an execution with parameters.


setVariable

Execution setVariable(java.lang.String executionId,
                      java.lang.String name,
                      java.lang.Object value)
creates or overwrites a variable value on the referenced execution


setVariables

Execution setVariables(java.lang.String executionId,
                       java.util.Map<java.lang.String,java.lang.Object> variables)
creates or overwrites the variable values on the referenced execution


getVariable

java.lang.Object getVariable(java.lang.String executionId,
                             java.lang.String variableName)
retrieves a variable


getVariables

java.util.Map<java.lang.String,java.lang.Object> getVariables(java.lang.String executionId,
                                                              java.util.List<java.lang.String> variableNames)
retrieves a map of variables



Copyright © 2009 OW2 Consortium. All Rights Reserved.