com.opensymphony.workflow
Interface Workflow

All Known Implementing Classes:
AbstractWorkflow, EJBWorkflow, OfbizSOAPWorkflow, BasicSOAPWorkflow

public interface Workflow

Version:
$Revision: 1.9 $
Author:
Patrick Lightbody

Method Summary
 boolean canInitialize(java.lang.String workflowName, int initialState)
           
 long createEntry(java.lang.String workflowName)
          Create a new workflow entry
 void doAction(long id, int actionId, java.util.Map inputs)
           
 void executeTriggerFunction(long id, int triggerId)
           
 int[] getActionableSteps(java.lang.String workflowName)
           
 java.lang.String getActionName(long id, int actionId)
           
 int[] getAvailableActions(long id)
           
 HistoryStep getCurrentStatus(long id)
           
 WorkflowHistory getHistory(long id)
           
 com.opensymphony.module.propertyset.PropertySet getPropertySet(long id)
           
 java.util.List getSecurityPermissions(long id)
           
 java.lang.String getStepName(long id, int stepId)
           
 void initialize(long id, int initialState, java.util.Map inputs)
           
 boolean isInitialized(long id)
           
 

Method Detail

createEntry

public long createEntry(java.lang.String workflowName)
Create a new workflow entry
Parameters:
workflowName - The name of the XML file for this workflow
Returns:
The id of the new workflow

initialize

public void initialize(long id,
                       int initialState,
                       java.util.Map inputs)
                throws InvalidRoleException,
                       InvalidInputException

isInitialized

public boolean isInitialized(long id)

canInitialize

public boolean canInitialize(java.lang.String workflowName,
                             int initialState)

getAvailableActions

public int[] getAvailableActions(long id)

doAction

public void doAction(long id,
                     int actionId,
                     java.util.Map inputs)
              throws InvalidInputException

getCurrentStatus

public HistoryStep getCurrentStatus(long id)

getHistory

public WorkflowHistory getHistory(long id)

getSecurityPermissions

public java.util.List getSecurityPermissions(long id)

getActionableSteps

public int[] getActionableSteps(java.lang.String workflowName)

getActionName

public java.lang.String getActionName(long id,
                                      int actionId)

getStepName

public java.lang.String getStepName(long id,
                                    int stepId)

getPropertySet

public com.opensymphony.module.propertyset.PropertySet getPropertySet(long id)

executeTriggerFunction

public void executeTriggerFunction(long id,
                                   int triggerId)

See www.opensymphony.com for more information.