Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: BPMS.java 10489 2008-01-23 17:53:38Z dfeist $
   * --------------------------------------------------------------------------------------
   * Copyright (c) MuleSource, Inc.  All rights reserved.  http://www.mulesource.com
   *
   * The software in this package is published under the terms of the CPAL v1.0
   * license, a copy of which has been included with this distribution in the
   * LICENSE.txt file.
   */
 
 package org.mule.transport.bpm;
 
 import java.util.Map;

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
 
 public interface BPMS
 {
    
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.
 
     public void setMessageService(MessageService msgService);

    
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
 
     public Object startProcess(Object processTypeObject transitionMap processVariablesthrows 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
 
     public Object advanceProcess(Object processIdObject transitionMap processVariablesthrows 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
 
     public Object updateProcess(Object processIdMap processVariablesthrows Exception;

    
Abort a running process (end abnormally). This method is OPTIONAL.

Parameters:
processId - an ID which identifies the running process
 
     public void abortProcess(Object processIdthrows Exception;

    
Looks up an already-running process. This method is OPTIONAL.

Returns:
an object representing the process
 
     public Object lookupProcess(Object processIdthrows Exception;

    

Returns:
an ID which identifies the given process. This method is OPTIONAL.
 
     public Object getId(Object processthrows Exception;

    

Returns:
the current state of the given process. This method is OPTIONAL.
 
     public Object getState(Object processthrows Exception;

    

Returns:
true if the given process has ended. This method is OPTIONAL.
 
     public boolean hasEnded(Object processthrows Exception;

    

Returns:
true if the object is a valid process This method is OPTIONAL.
    public boolean isProcess(Object objthrows Exception;
New to GrepCode? Check out our FAQ X