org.jbpm
Interface PvmService

All Known Implementing Classes:

PvmServiceImpl

public interface PvmService

session facade interface for the Process Virtual Machine.

Author:

Tom Baeyens

Method Summary

ProcessDefinition	deploy(Deployment deployment) deploy a new process definition into the process repository.
Execution	findExecution(long executionDbid) the execution with the given database primary key
Execution	findExecution(java.lang.String processDefinitionName, java.lang.String key) the execution that is uniquely defined by the process definition and the business key.
ProcessDefinition	findLatestProcessDefinition(java.lang.String processDefinitionName) latest version of the processDefinition with the given name.
ProcessDefinition	findProcessDefinition(long processDefinitionDbid) specific processDefinition by database primary key.
ProcessDefinition	findProcessDefinition(java.lang.String processDefinitionName, int processDefinitionVersion) specific version of a named processDefinition.
java.util.List<java.lang.String>	findProcessDefinitionNames() all deployed process names.
java.util.List<ProcessDefinition>	findProcessDefinitions(java.lang.String processDefinitionName) all versions of the given process.
java.util.List<Job<?>>	getJobs() fetches all jobs ordered in ascending dueDate.
java.lang.Object	getVariable(long executionDbid, java.lang.String variableName) retrieves a variable
java.util.Map<java.lang.String,java.lang.Object>	getVariables(long executionDbid, java.util.List<java.lang.String> variableNames) retrieves a map of variables
Execution	setVariable(long executionDbid, java.lang.String name, java.lang.Object value) creates or overwrites a variable value on the referenced execution
Execution	setVariables(long executionDbid, java.util.Map<java.lang.String,java.lang.Object> variables) creates or overwrites the variable values on the referenced execution
Execution	signal(long executionDbid) provides an external trigger to an execution.
Execution	signal(long executionDbid, java.lang.String signalName) provides a named external trigger to an execution.
Execution	signal(long executionDbid, 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(long processDefinitionDbid) starts a new execution in the exact version indicated by processDefinitionDbid.
Execution	startExecution(long processDefinitionDbid, java.util.Map<java.lang.String,java.lang.Object> executionVariables) starts a new execution in the exact version indicated by processDefinitionDbid.
Execution	startExecution(long processDefinitionDbid, java.util.Map<java.lang.String,java.lang.Object> executionVariables, java.lang.String executionKey) starts a new execution in the exact version indicated by processDefinitionDbid.
Execution	startExecution(java.lang.String processDefinitionName) starts a new execution in the latest version of the given process definition.
Execution	startExecution(java.lang.String processDefinitionName, java.util.Map<java.lang.String,java.lang.Object> executionVariables) starts a new execution in the latest version of the given process definition.
Execution	startExecution(java.lang.String processDefinitionName, java.util.Map<java.lang.String,java.lang.Object> executionVariables, java.lang.String executionKey) starts a new execution in the latest version of the given process definition.

Method Detail

deploy

ProcessDefinition deploy(Deployment deployment)

deploy a new process definition into the process repository.

findProcessDefinitionNames

java.util.List<java.lang.String> findProcessDefinitionNames()

all deployed process names.

findProcessDefinitions

java.util.List<ProcessDefinition> findProcessDefinitions(java.lang.String processDefinitionName)

all versions of the given process.

findLatestProcessDefinition

ProcessDefinition findLatestProcessDefinition(java.lang.String processDefinitionName)

latest version of the processDefinition with the given name.

findProcessDefinition

ProcessDefinition findProcessDefinition(java.lang.String processDefinitionName,
                                        int processDefinitionVersion)

specific version of a named processDefinition.

findProcessDefinition

ProcessDefinition findProcessDefinition(long processDefinitionDbid)

specific processDefinition by database primary key.

startExecution

Execution startExecution(java.lang.String processDefinitionName)

starts a new execution in the latest version of the given process definition.

startExecution

Execution startExecution(long processDefinitionDbid)

starts a new execution in the exact version indicated by processDefinitionDbid.

startExecution

Execution startExecution(java.lang.String processDefinitionName,
                         java.util.Map<java.lang.String,java.lang.Object> executionVariables)

starts a new execution in the latest version of the given process definition.

startExecution

Execution startExecution(long processDefinitionDbid,
                         java.util.Map<java.lang.String,java.lang.Object> executionVariables)

starts a new execution in the exact version indicated by processDefinitionDbid.

startExecution

Execution startExecution(java.lang.String processDefinitionName,
                         java.util.Map<java.lang.String,java.lang.Object> executionVariables,
                         java.lang.String executionKey)

starts a new execution in the latest version of the given process definition.

startExecution

Execution startExecution(long processDefinitionDbid,
                         java.util.Map<java.lang.String,java.lang.Object> executionVariables,
                         java.lang.String executionKey)

starts a new execution in the exact version indicated by processDefinitionDbid.

findExecution

Execution findExecution(long executionDbid)

the execution with the given database primary key

findExecution

Execution findExecution(java.lang.String processDefinitionName,
                        java.lang.String key)

the execution that is uniquely defined by the process definition and the business key.

signal

Execution signal(long executionDbid)

provides an external trigger to an execution.

signal

Execution signal(long executionDbid,
                 java.lang.String signalName)

provides a named external trigger to an execution.

signal

Execution signal(long executionDbid,
                 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(long executionDbid,
                      java.lang.String name,
                      java.lang.Object value)

creates or overwrites a variable value on the referenced execution

setVariables

Execution setVariables(long executionDbid,
                       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(long executionDbid,
                             java.lang.String variableName)

retrieves a variable

getVariables

java.util.Map<java.lang.String,java.lang.Object> getVariables(long executionDbid,
                                                              java.util.List<java.lang.String> variableNames)

retrieves a map of variables

getJobs

java.util.List<Job<?>> getJobs()

fetches all jobs ordered in ascending dueDate.