com.silverpeas.workflow.api
Interface UpdatableProcessInstanceManager

All Superinterfaces:

ProcessInstanceManager

All Known Implementing Classes:

ProcessInstanceManagerImpl

public interface UpdatableProcessInstanceManager
extends ProcessInstanceManager

The workflow engine services relate to process instance management.

Method Summary

ProcessInstance	createProcessInstance(String modelId) Creates a new process instance
void	lock(ProcessInstance instance, State state, User user) Locks the given instance for the given instance and state
void	removeProcessInstance(String instanceId) Removes a new process instance
void	unlock(ProcessInstance instance, State state, User user) Locks the given instance for the given instance and state

Methods inherited from interface com.silverpeas.workflow.api.ProcessInstanceManager

createActor, createHistoryStep, getProcessInstance, getProcessInstances, getProcessInstances, getProcessInstancesInState, getTimeOutProcessInstances

Method Detail

createProcessInstance

ProcessInstance createProcessInstance(String modelId)
                                      throws WorkflowException

Creates a new process instance

Parameters:

modelId - model id

Returns:

the new ProcessInstance object

Throws:

WorkflowException

removeProcessInstance

void removeProcessInstance(String instanceId)
                           throws WorkflowException

Removes a new process instance

Parameters:

instanceId - instance id

Throws:

WorkflowException

lock

void lock(ProcessInstance instance,
          State state,
          User user)
          throws WorkflowException

Locks the given instance for the given instance and state

Parameters:

instance - instance that have to be locked

state - state that have to be locked

user - the locking user

Throws:

WorkflowException

unlock

void unlock(ProcessInstance instance,
            State state,
            User user)
            throws WorkflowException

Locks the given instance for the given instance and state

Parameters:

instance - instance that have to be locked

state - state that have to be locked

user - the locking user

Throws:

WorkflowException