| java.lang.Object
 com.opensymphony.workflow.AbstractWorkflow
All known Subclasses: com.opensymphony.workflow.ofbiz.OfbizWorkflow, com.opensymphony.workflow.ejb.WorkflowEJB, com.opensymphony.workflow.basic.BasicWorkflow,
| AbstractWorkflow | | public class AbstractWorkflow implements Workflow(Code) | | Abstract workflow instance that serves as the base for specific implementations, such as EJB or SOAP.
author:
Pat Lightbody
author:
Hani Suleiman |
| Method Summary | |
| public boolean | canInitialize(String workflowName, int initialAction)
| | public boolean | canInitialize(String workflowName, int initialAction, Map inputs)
| | public boolean | canModifyEntryState(long id, int newState)
| | public void | changeEntryState(long id, int newState)
| | protected void | checkImplicitFinish(ActionDescriptor action, long id)
| | protected void | completeEntry(ActionDescriptor action, long id, Collection currentSteps, int state)
Mark the specified entry as completed, and move all current steps to history. | | public void | doAction(long id, int actionId, Map inputs)
| | protected void | executeFunction(FunctionDescriptor function, Map transientVars, PropertySet ps)
Executes a function. | | public void | executeTriggerFunction(long id, int triggerId)
| | public int[] | getAvailableActions(long id)
| | public int[] | getAvailableActions(long id, Map inputs)
Get the available actions for the specified workflow instance. | | protected List | getAvailableActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps)
| | protected int[] | getAvailableAutoActions(long id, Map inputs)
| | protected List | getAvailableAutoActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps)
| | public Configuration | getConfiguration()
Get the configuration for this workflow. | | public List | getCurrentSteps(long id)
| | public int | getEntryState(long id)
| | public List | getHistorySteps(long id)
| | protected WorkflowStore | getPersistence()
| | public Properties | getPersistenceProperties()
| | public PropertySet | getPropertySet(long id)
| | public TypeResolver | getResolver()
| | public List | getSecurityPermissions(long id)
| | public List | getSecurityPermissions(long id, Map inputs)
| | public WorkflowDescriptor | getWorkflowDescriptor(String workflowName)
Returns a workflow definition object associated with the given name. | | public String | getWorkflowName(long id)
| | public String[] | getWorkflowNames()
| | public long | initialize(String workflowName, int initialAction, Map inputs)
| | protected boolean | passesCondition(ConditionDescriptor conditionDesc, Map transientVars, PropertySet ps, int currentStepId)
| | protected boolean | passesConditions(String conditionType, List conditions, Map transientVars, PropertySet ps, int currentStepId)
| | protected boolean | passesConditions(ConditionsDescriptor descriptor, Map transientVars, PropertySet ps, int currentStepId)
| | protected void | populateTransientMap(WorkflowEntry entry, Map transientVars, List registers, Integer actionId, Collection currentSteps, PropertySet ps)
| | public List | query(WorkflowQuery query)
| | public List | query(WorkflowExpressionQuery query)
| | public boolean | removeWorkflowDescriptor(String workflowName)
| | public boolean | saveWorkflowDescriptor(String workflowName, WorkflowDescriptor descriptor, boolean replace)
| | public void | setConfiguration(Configuration configuration)
| | public void | setResolver(TypeResolver resolver)
| | protected boolean | transitionWorkflow(WorkflowEntry entry, List currentSteps, WorkflowStore store, WorkflowDescriptor wf, ActionDescriptor action, Map transientVars, Map inputs, PropertySet ps)
| | protected void | verifyInputs(WorkflowEntry entry, List validators, Map transientVars, PropertySet ps)
Validates input against a list of ValidatorDescriptor objects. |
| AbstractWorkflow | | public AbstractWorkflow()(Code) | | |
| canInitialize | | public boolean canInitialize(String workflowName, int initialAction)(Code) | | |
| canInitialize | | public boolean canInitialize(String workflowName, int initialAction, Map inputs)(Code) | |
Parameters:
workflowName - the name of the workflow to check
Parameters:
initialAction - The initial action to check
Parameters:
inputs - the inputs map true if the workflow can be initialized |
| canModifyEntryState | | public boolean canModifyEntryState(long id, int newState)(Code) | | |
| executeFunction | | protected void executeFunction(FunctionDescriptor function, Map transientVars, PropertySet ps) throws WorkflowException(Code) | | Executes a function.
Parameters:
function - the function to execute
Parameters:
transientVars - the transientVars given by the end-user
Parameters:
ps - the persistence variables |
| getAvailableActions | | public int[] getAvailableActions(long id, Map inputs)(Code) | | Get the available actions for the specified workflow instance.
Parameters:
id - The workflow instance id.
Parameters:
inputs - The inputs map to pass on to conditions 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 workflowdescriptor is no longer available or has become invalid. |
| getAvailableAutoActions | | protected int[] getAvailableAutoActions(long id, Map inputs)(Code) | | |
| getConfiguration | | public Configuration getConfiguration()(Code) | | Get the configuration for this workflow.
This method also checks if the configuration has been initialized, and if not, initializes it.
The configuration that was set.If no configuration was set, then the default (static) configuration is returned. |
| getCurrentSteps | | public List getCurrentSteps(long id)(Code) | | |
| getEntryState | | public int getEntryState(long id)(Code) | | |
| getHistorySteps | | public List getHistorySteps(long id)(Code) | | |
| getPropertySet | | public PropertySet getPropertySet(long id)(Code) | | Get the PropertySet for the specified workflow ID
Parameters:
id - The workflow ID |
| getSecurityPermissions | | public List getSecurityPermissions(long id)(Code) | | |
| getSecurityPermissions | | public List getSecurityPermissions(long id, Map inputs)(Code) | | |
| getWorkflowDescriptor | | public WorkflowDescriptor getWorkflowDescriptor(String workflowName)(Code) | | Returns a workflow definition object associated with the given name.
Parameters:
workflowName - the name of the workflow the object graph that represents a workflow definition |
| getWorkflowNames | | public String[] getWorkflowNames()(Code) | | Get a list of workflow names available
String[] an array of workflow names. |
| verifyInputs | | protected void verifyInputs(WorkflowEntry entry, List validators, Map transientVars, PropertySet ps) throws WorkflowException(Code) | | Validates input against a list of ValidatorDescriptor objects.
Parameters:
entry - the workflow instance
Parameters:
validators - the list of ValidatorDescriptors
Parameters:
transientVars - the transientVars
Parameters:
ps - the persistence variables
throws:
InvalidInputException - if the input is deemed invalid by any validator |
|
|