|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.opensymphony.workflow.AbstractWorkflow
Field Summary | |
protected WorkflowContext |
context
|
Constructor Summary | |
AbstractWorkflow()
|
Method Summary | |
boolean |
canInitialize(java.lang.String workflowName,
int initialState)
Check if the calling user has enough permissions to initialise the specified workflow |
long |
createEntry(java.lang.String workflowName)
Create a workflow entry |
protected java.util.Map |
createVariableMap(WorkflowEntry entry,
java.util.List registers)
|
void |
doAction(long id,
int actionId,
java.util.Map inputs)
perform an action on the specified workflow |
protected boolean |
evaluateExpression(java.lang.String expr,
WorkflowEntry entry,
java.util.List registers)
|
protected void |
executeFunction(FunctionDescriptor function,
WorkflowEntry entry,
java.util.Map inputs,
java.util.List registers)
|
void |
executeTriggerFunction(long id,
int triggerId)
|
int[] |
getActionableSteps(java.lang.String workflowName)
Get an array of steps that have actions in the specified workflow |
java.lang.String |
getActionName(long id,
int actionId)
Get a verbose string action name for a specified workflow action within the current step |
int[] |
getAvailableActions(long id)
Get an array of possible actions for the specified workflow |
HistoryStep |
getCurrentStatus(long id)
Get the current status of the specified workflow |
WorkflowHistory |
getHistory(long id)
Get the workflow history |
protected Persistence |
getPersistence()
|
com.opensymphony.module.propertyset.PropertySet |
getPropertySet(long id)
|
java.util.List |
getSecurityPermissions(long id)
Get a collection of currently defined permissions for the specified workflow |
java.lang.String |
getStepName(long id,
int stepId)
Get a string name for the specified step |
protected WorkflowDescriptor |
getWorkflow(java.lang.String name)
|
void |
initialize(long id,
int initialState,
java.util.Map inputs)
|
boolean |
isInitialized(long id)
Check if the specified workflow has been initialized |
protected void |
loadConfig()
|
protected void |
setBshVariables(bsh.Interpreter i,
java.util.Map variables)
|
protected java.lang.String |
translateVariables(java.lang.String s,
com.opensymphony.module.propertyset.PropertySet ps)
|
protected boolean |
validRole(java.util.List roles)
|
protected void |
verifyInputs(WorkflowEntry entry,
java.util.List validators,
java.util.Map inputs,
java.util.List registers)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected WorkflowContext context
Constructor Detail |
public AbstractWorkflow()
Method Detail |
protected void loadConfig()
protected WorkflowDescriptor getWorkflow(java.lang.String name)
protected java.util.Map createVariableMap(WorkflowEntry entry, java.util.List registers)
protected void setBshVariables(bsh.Interpreter i, java.util.Map variables) throws bsh.EvalError
protected boolean evaluateExpression(java.lang.String expr, WorkflowEntry entry, java.util.List registers)
protected java.lang.String translateVariables(java.lang.String s, com.opensymphony.module.propertyset.PropertySet ps)
protected Persistence getPersistence()
public com.opensymphony.module.propertyset.PropertySet getPropertySet(long id)
getPropertySet
in interface Workflow
public int[] getActionableSteps(java.lang.String workflowName)
getActionableSteps
in interface Workflow
workflowName
- The name of the workflowpublic long createEntry(java.lang.String workflowName)
createEntry
in interface Workflow
workflowName
- The name of the workflow to createpublic boolean isInitialized(long id)
isInitialized
in interface Workflow
id
- The workflow idpublic boolean canInitialize(java.lang.String workflowName, int initialState)
canInitialize
in interface Workflow
workflowName
- The name of the workflow to checkinitialState
- The id of the initial state to checkpublic void initialize(long id, int initialState, java.util.Map inputs) throws InvalidRoleException, InvalidInputException
initialize
in interface Workflow
public void doAction(long id, int actionId, java.util.Map inputs) throws InvalidInputException
doAction
in interface Workflow
id
- The workflow id to perform the action onactionId
- The action id to perform (action id's are listed in the workflow descriptor)inputs
- InvalidInputException
- public int[] getAvailableActions(long id)
getAvailableActions
in interface Workflow
id
- the workflow to get actions forpublic java.lang.String getActionName(long id, int actionId)
getActionName
in interface Workflow
id
- The workflow id to queryactionId
- The action id to get the name forpublic java.lang.String getStepName(long id, int stepId)
getStepName
in interface Workflow
id
- The workflow idstepId
- The step idpublic WorkflowHistory getHistory(long id)
getHistory
in interface Workflow
id
- the workflow idpublic HistoryStep getCurrentStatus(long id)
getCurrentStatus
in interface Workflow
id
- The workflow IDpublic java.util.List getSecurityPermissions(long id)
getSecurityPermissions
in interface Workflow
id
- the workflow IDprotected boolean validRole(java.util.List roles)
protected void executeFunction(FunctionDescriptor function, WorkflowEntry entry, java.util.Map inputs, java.util.List registers)
protected void verifyInputs(WorkflowEntry entry, java.util.List validators, java.util.Map inputs, java.util.List registers) throws InvalidInputException
public void executeTriggerFunction(long id, int triggerId)
executeTriggerFunction
in interface Workflow
|
See www.opensymphony.com for more information. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |