org.mule.providers.bpm
Interface BPMS

All Known Implementing Classes:

Jbpm

public interface BPMS

Method Summary

void	abortProcess(Object processId) Abort (end abnormally) a running process.
Object	advanceProcess(Object processId, Object transition, Map processVariables) Advance an already-running process.
Object	getId(Object process)
Object	getState(Object process)
boolean	hasEnded(Object process)
boolean	isProcess(Object obj)
Object	lookupProcess(Object processId) Looks up an already-running process.
void	setMessageService(MessageService msgService) Set a callback to generate messages within Mule.
Object	startProcess(Object processType, Map processVariables) Start a new process.
Object	updateProcess(Object processId, Map processVariables) Update the variables/parameters for an already-running process.

Method Detail

setMessageService

public void setMessageService(MessageService msgService)

Set a callback to generate messages within Mule.

Parameters:

msgService - An interface within Mule which the BPMS may call to generate Mule messages.

startProcess

public Object startProcess(Object processType,
                           Map processVariables)
                    throws Exception

Start a new process.

Parameters:

processType - - the type of process to start

processVariables - - optional process variables/parameters to set

Returns:

an object representing the new process

Throws:

Exception

advanceProcess

public Object advanceProcess(Object processId,
                             Object transition,
                             Map processVariables)
                      throws Exception

Advance an already-running process.

Parameters:

processId - - an ID which identifies the running process

transition - - optionally specify which transition to take from the current state

processVariables - - optional process variables/parameters to set

Returns:

an object representing the process in its new (i.e., advanced) state

Throws:

Exception

updateProcess

public Object updateProcess(Object processId,
                            Map processVariables)
                     throws Exception

Update the variables/parameters for an already-running process.

Parameters:

processId - - an ID which identifies the running process

processVariables - - process variables/parameters to set

Returns:

an object representing the process in its new (i.e., updated) state

Throws:

Exception

abortProcess

public void abortProcess(Object processId)
                  throws Exception

Abort (end abnormally) a running process.

Parameters:

processId - - an ID which identifies the running process

Throws:

Exception

lookupProcess

public Object lookupProcess(Object processId)
                     throws Exception

Looks up an already-running process.

Returns:

an object representing the process

Throws:

Exception

getId

public Object getId(Object process)
             throws Exception

Returns:

an ID which identifies the given process.

Throws:

Exception

getState

public Object getState(Object process)
                throws Exception

Returns:

the current state of the given process.

Throws:

Exception

hasEnded

public boolean hasEnded(Object process)
                 throws Exception

Returns:

true if the given process has ended.

Throws:

Exception

isProcess

public boolean isProcess(Object obj)
                  throws Exception

Returns:

true if the object is a valid process

Throws:

Exception