org.mule.module.bpm
Interface BPMS

All Known Implementing Classes:
Jbpm

public interface BPMS

A generic interface for any Process Engine. Theoretically, any Process Engine can be "plugged into" Mule via the BPM connector if it implements this interface.

See Also:
MessageService

Method Summary
 void abortProcess(java.lang.Object processId)
          Abort a running process (end abnormally).
 java.lang.Object advanceProcess(java.lang.Object processId, java.lang.Object transition, java.util.Map processVariables)
          Advance an already-running process.
 void deployProcess(java.lang.String resource)
          Deploy (not start) a process to the BPMS based on a process definition file.
 java.lang.Object getId(java.lang.Object process)
           
 java.lang.Object getState(java.lang.Object process)
           
 boolean hasEnded(java.lang.Object process)
           
 boolean isProcess(java.lang.Object obj)
           
 java.lang.Object lookupProcess(java.lang.Object processId)
          Looks up an already-running process.
 void setMessageService(MessageService msgService)
          MessageService contains a callback method used to generate Mule messages from your process.
 java.lang.Object startProcess(java.lang.Object processType, java.lang.Object transition, java.util.Map processVariables)
          Start a new process.
 void undeployProcess(java.lang.String resource)
          Undeploy a process from the BPMS.
 java.lang.Object updateProcess(java.lang.Object processId, java.util.Map processVariables)
          Update the variables/parameters for an already-running process.
 

Method Detail

setMessageService

void setMessageService(MessageService msgService)
MessageService contains a callback method used to generate Mule messages from your process. This method is REQUIRED.

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

deployProcess

void deployProcess(java.lang.String resource)
                   throws java.lang.Exception
Deploy (not start) a process to the BPMS based on a process definition file.

Parameters:
resource - - process definition file
Throws:
java.lang.Exception

undeployProcess

void undeployProcess(java.lang.String resource)
                     throws java.lang.Exception
Undeploy a process from the BPMS.

Parameters:
resource - - process definition file
Throws:
java.lang.Exception

startProcess

java.lang.Object startProcess(java.lang.Object processType,
                              java.lang.Object transition,
                              java.util.Map processVariables)
                              throws java.lang.Exception
Start a new process. This method is REQUIRED.

Parameters:
processType - - the type of process to start
processVariables - - optional process variables/parameters to set
Returns:
an object representing the new process
Throws:
java.lang.Exception

advanceProcess

java.lang.Object advanceProcess(java.lang.Object processId,
                                java.lang.Object transition,
                                java.util.Map processVariables)
                                throws java.lang.Exception
Advance an already-running process. This method is REQUIRED.

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:
java.lang.Exception

updateProcess

java.lang.Object updateProcess(java.lang.Object processId,
                               java.util.Map processVariables)
                               throws java.lang.Exception
Update the variables/parameters for an already-running process. This method is OPTIONAL.

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:
java.lang.Exception

abortProcess

void abortProcess(java.lang.Object processId)
                  throws java.lang.Exception
Abort a running process (end abnormally). This method is OPTIONAL.

Parameters:
processId - - an ID which identifies the running process
Throws:
java.lang.Exception

lookupProcess

java.lang.Object lookupProcess(java.lang.Object processId)
                               throws java.lang.Exception
Looks up an already-running process. This method is OPTIONAL.

Returns:
an object representing the process
Throws:
java.lang.Exception

getId

java.lang.Object getId(java.lang.Object process)
                       throws java.lang.Exception
Returns:
an ID which identifies the given process. This method is OPTIONAL.
Throws:
java.lang.Exception

getState

java.lang.Object getState(java.lang.Object process)
                          throws java.lang.Exception
Returns:
the current state of the given process. This method is OPTIONAL.
Throws:
java.lang.Exception

hasEnded

boolean hasEnded(java.lang.Object process)
                 throws java.lang.Exception
Returns:
true if the given process has ended. This method is OPTIONAL.
Throws:
java.lang.Exception

isProcess

boolean isProcess(java.lang.Object obj)
                  throws java.lang.Exception
Returns:
true if the object is a valid process This method is OPTIONAL.
Throws:
java.lang.Exception


Copyright © 2003-2010 MuleSoft, Inc.. All Rights Reserved.