com.opensymphony.workflow.ejb
Interface WorkflowRemote

All Superinterfaces:
javax.ejb.EJBObject, Remote

public interface WorkflowRemote
extends javax.ejb.EJBObject

Remote interface for Workflow.

Version:
$Revision: 1.7 $
Author:
Pat Lightbody, Hani Suleiman

Method Summary
 boolean canInitialize(String workflowName, int initialAction)
           
 boolean canInitialize(String workflowName, int initialAction, Map inputs)
           
 boolean canModifyEntryState(long id, int newState)
           
 void changeEntryState(long id, int newState)
           
 void doAction(long id, int actionId, Map inputs)
           
 void executeTriggerFunction(long id, int triggerId)
           
 int[] getAvailableActions(long id)
           
 int[] getAvailableActions(long id, Map inputs)
          Get the available actions for the specified workflow instance.
 List getCurrentSteps(long id)
           
 int getEntryState(long id)
           
 List getHistorySteps(long id)
           
 Properties getPersistenceProperties()
           
 com.opensymphony.module.propertyset.PropertySet getPropertySet(long id)
          Get the PropertySet for the specified workflow ID
 List getSecurityPermissions(long id)
           
 List getSecurityPermissions(long id, Map inputs)
           
 WorkflowDescriptor getWorkflowDescriptor(String workflowName)
          Returns a workflow definition object associated with the given name.
 String getWorkflowName(long id)
           
 String[] getWorkflowNames()
          Get a list of workflow names available
 long initialize(String workflowName, int initialAction, Map inputs)
           
 List query(WorkflowExpressionQuery query)
           
 List query(WorkflowQuery query)
           
 boolean removeWorkflowDescriptor(String workflowName)
           
 boolean saveWorkflowDescriptor(String workflowName, WorkflowDescriptor descriptor, boolean replace)
           
 void setConfiguration(Configuration configuration)
           
 
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
 

Method Detail

getAvailableActions

int[] getAvailableActions(long id)
                          throws RemoteException
Throws:
RemoteException

getAvailableActions

int[] getAvailableActions(long id,
                          Map inputs)
                          throws RemoteException
Get the available actions for the specified workflow instance.

Parameters:
id - The workflow instance id.
inputs - The inputs map to pass on to conditions
Returns:
An array of action id's that can be performed on the specified entry.
Throws:
IllegalArgumentException - if the specified id does not exist, or if its workflow descriptor is no longer available or has become invalid.
RemoteException

setConfiguration

void setConfiguration(Configuration configuration)
                      throws RemoteException
Throws:
RemoteException

getCurrentSteps

List getCurrentSteps(long id)
                     throws RemoteException
Throws:
RemoteException

getEntryState

int getEntryState(long id)
                  throws RemoteException
Throws:
RemoteException

getHistorySteps

List getHistorySteps(long id)
                     throws RemoteException
Throws:
RemoteException

getPersistenceProperties

Properties getPersistenceProperties()
                                    throws RemoteException
Throws:
RemoteException

getPropertySet

com.opensymphony.module.propertyset.PropertySet getPropertySet(long id)
                                                               throws RemoteException
Get the PropertySet for the specified workflow ID

Parameters:
id - The workflow ID
Throws:
RemoteException

getSecurityPermissions

List getSecurityPermissions(long id)
                            throws RemoteException
Throws:
RemoteException

getSecurityPermissions

List getSecurityPermissions(long id,
                            Map inputs)
                            throws RemoteException
Throws:
RemoteException

getWorkflowDescriptor

WorkflowDescriptor getWorkflowDescriptor(String workflowName)
                                         throws RemoteException
Returns a workflow definition object associated with the given name.

Parameters:
workflowName - the name of the workflow
Returns:
the object graph that represents a workflow definition
Throws:
RemoteException

getWorkflowName

String getWorkflowName(long id)
                       throws RemoteException
Throws:
RemoteException

getWorkflowNames

String[] getWorkflowNames()
                          throws RemoteException
Get a list of workflow names available

Returns:
String[] an array of workflow names.
Throws:
RemoteException

canInitialize

boolean canInitialize(String workflowName,
                      int initialAction)
                      throws RemoteException
Throws:
RemoteException

canInitialize

boolean canInitialize(String workflowName,
                      int initialAction,
                      Map inputs)
                      throws RemoteException
Throws:
RemoteException

canModifyEntryState

boolean canModifyEntryState(long id,
                            int newState)
                            throws RemoteException
Throws:
RemoteException

changeEntryState

void changeEntryState(long id,
                      int newState)
                      throws WorkflowException,
                             RemoteException
Throws:
WorkflowException
RemoteException

doAction

void doAction(long id,
              int actionId,
              Map inputs)
              throws WorkflowException,
                     RemoteException
Throws:
WorkflowException
RemoteException

executeTriggerFunction

void executeTriggerFunction(long id,
                            int triggerId)
                            throws WorkflowException,
                                   RemoteException
Throws:
WorkflowException
RemoteException

initialize

long initialize(String workflowName,
                int initialAction,
                Map inputs)
                throws InvalidRoleException,
                       InvalidInputException,
                       StoreException,
                       WorkflowException,
                       RemoteException
Throws:
InvalidRoleException
InvalidInputException
StoreException
WorkflowException
RemoteException

query

List query(WorkflowQuery query)
           throws StoreException,
                  RemoteException
Throws:
StoreException
RemoteException

query

List query(WorkflowExpressionQuery query)
           throws WorkflowException,
                  RemoteException
Throws:
WorkflowException
RemoteException

removeWorkflowDescriptor

boolean removeWorkflowDescriptor(String workflowName)
                                 throws FactoryException,
                                        RemoteException
Throws:
FactoryException
RemoteException

saveWorkflowDescriptor

boolean saveWorkflowDescriptor(String workflowName,
                               WorkflowDescriptor descriptor,
                               boolean replace)
                               throws FactoryException,
                                      RemoteException
Throws:
FactoryException
RemoteException

OpenSymphony Workflow Project Page