org.jbpm
Interface ExecutionReadService

All Superinterfaces:

Service

All Known Subinterfaces:

ExecutionService

public interface ExecutionReadService

extends Service

is the read-only part of the execution service.

Method Summary

java.util.List	findActiveTokensInState(java.lang.Long stateId) retrieves non-finished tokens for the given state.
java.util.List	findActiveTokensInState(java.lang.Long[] stateIds) retrieves non-finished tokens for the given states.
java.util.List	findByQuery(JbpmQuery jbpmQuery) exposes the hibernate query language to jbpm clients.
java.util.List	getAllDefinitions() provides access to all versions of all the process definitions.
java.util.Collection	getAvailableTransitions(java.lang.Long tokenId) retrieves the list of currently available transition names for a given token.
Definition	getDefinition(java.lang.Long definitionId) retrieves a definition from an id.
byte[]	getFile(java.lang.Long processDefinitionId, java.lang.String fileName) provides access to the files in the process archive.
Definition	getLatestDefinition(java.lang.String name) retrieves the latest version of the process definition with the given name.
java.util.Collection	getLatestDefinitions() retrieves only the latest versions of all the process definitions in the system.
ProcessInstance	getProcessInstance(java.lang.Long processInstanceId) retrieves the specified ProcessInstance.
java.util.Collection	getTaskList(java.lang.String targetActorId) collects all org.jbpm.workflow.execution.Flows for which the given target-swimlane has to perform an activity.
Token	getToken(java.lang.Long tokenId) retrieves the specified Token.
java.util.Map	getVariables(java.lang.Long tokenId) retrieves the variables of the specified Token.

Methods inherited from interface org.jbpm.Service

close

Method Detail

getTaskList

public java.util.Collection getTaskList(java.lang.String targetActorId)

collects all org.jbpm.workflow.execution.Flows for which the given target-swimlane has to perform an activity.

Parameters:

targetActorId - specifies the swimlane for which the tasklist should be fetched.

Returns:

a Collection of org.jbpm.workflow.execution.Flows which are assigned to given swimlane.

Throws:

java.lang.NullPointerException - if targetActorId is null.

PersistenceException - if jbpm cannot contact its database.

getToken

public Token getToken(java.lang.Long tokenId)

retrieves the specified Token.

Parameters:

tokenId - the id of the token.

Throws:

java.lang.NullPointerException - if tokenId is null.

PersistenceException - if jbpm cannot contact its database.

getProcessInstance

public ProcessInstance getProcessInstance(java.lang.Long processInstanceId)

retrieves the specified ProcessInstance.

Parameters:

processInstanceId - the id of the process instance.

Throws:

java.lang.NullPointerException - if processInstanceId is null.

PersistenceException - if jbpm cannot contact its database.

getVariables

public java.util.Map getVariables(java.lang.Long tokenId)

retrieves the variables of the specified Token.

Parameters:

tokenId - the id of the token for which the variables should be retrieved.

Returns:

a Map from variable-names (String) to variable-values (Object). If no variables exist in the token, an empty Map is returned.

Throws:

java.lang.NullPointerException - if tokenId is null.

PersistenceException - if jbpm cannot contact its database.

getDefinition

public Definition getDefinition(java.lang.Long definitionId)

retrieves a definition from an id.

getLatestDefinition

public Definition getLatestDefinition(java.lang.String name)

retrieves the latest version of the process definition with the given name.

getLatestDefinitions

public java.util.Collection getLatestDefinitions()

retrieves only the latest versions of all the process definitions in the system.

getFile

public byte[] getFile(java.lang.Long processDefinitionId,
                      java.lang.String fileName)

provides access to the files in the process archive.

getAllDefinitions

public java.util.List getAllDefinitions()

provides access to all versions of all the process definitions.

getAvailableTransitions

public java.util.Collection getAvailableTransitions(java.lang.Long tokenId)

retrieves the list of currently available transition names for a given token.

Returns:

null if the token has ended, a list with one null-value if there is exact one leaving transition without a name or the transition names otherwise.

findActiveTokensInState

public java.util.List findActiveTokensInState(java.lang.Long stateId)

retrieves non-finished tokens for the given state.

findActiveTokensInState

public java.util.List findActiveTokensInState(java.lang.Long[] stateIds)

retrieves non-finished tokens for the given states.

findByQuery

public java.util.List findByQuery(JbpmQuery jbpmQuery)

exposes the hibernate query language to jbpm clients. See also www.hibernate.org