Package org.silverpeas.core.workflow.api

Interface ProcessInstanceManager

All Known Subinterfaces:

UpdatableProcessInstanceManager

All Known Implementing Classes:

ProcessInstanceManagerImpl

public interface ProcessInstanceManager

The workflow engine services relate to process instance management.

Method Summary

Modifier and Type	Method	Description
Actor	createActor(User user, String roleName, State state)	Builds an actor from a user and a role.
HistoryStep	createHistoryStep()	Build a new HistoryStep Return an object implementing HistoryStep interface
ProcessInstance	getProcessInstance(String instanceId)	Get the process instances for a given instance id
List<ProcessInstance>	getProcessInstances(String peasId, User user, String role)	Get the list of process instances for a given peas Id, user and role.
List<ProcessInstance>	getProcessInstances(String peasId, User user, String role, String[] userRoles, String[] groupIds)	Get the list of process instances for a given peas Id, user and role, and user's roles.
SilverpeasList<ProcessInstance>	getTimeOutProcessInstances()	Get the list of process instances for which timeout date is over

Method Detail

getProcessInstances

List<ProcessInstance> getProcessInstances(String peasId,
                                          User user,
                                          String role)
                                   throws WorkflowException

Get the list of process instances for a given peas Id, user and role.

Parameters:

peasId - id of processManager instance

user - user for who the process instance list is

role - role name of the user for who the process instance list is (useful when user has different roles)

Returns:

an array of ProcessInstance objects

Throws:

WorkflowException

getProcessInstances

List<ProcessInstance> getProcessInstances(String peasId,
                                          User user,
                                          String role,
                                          String[] userRoles,
                                          String[] groupIds)
                                   throws WorkflowException

Get the list of process instances for a given peas Id, user and role, and user's roles.

Parameters:

peasId - id of processManager instance

user - user for who the process instance list is

role - role name of the user for who the process instance list is (useful when user has

userRoles - all role names that user has for this component instance different roles)

Returns:

an array of ProcessInstance objects

Throws:

WorkflowException

getProcessInstance

ProcessInstance getProcessInstance(String instanceId)
                            throws WorkflowException

Get the process instances for a given instance id

Parameters:

instanceId - id of searched instance

Returns:

the searched process instance

Throws:

WorkflowException

createHistoryStep

HistoryStep createHistoryStep()

Build a new HistoryStep Return an object implementing HistoryStep interface

createActor

Actor createActor(User user,
                  String roleName,
                  State state)

Builds an actor from a user and a role.

getTimeOutProcessInstances

SilverpeasList<ProcessInstance> getTimeOutProcessInstances()
                                                    throws WorkflowException

Get the list of process instances for which timeout date is over

Returns:

an array of ProcessInstance objects

Throws:

WorkflowException