|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.opensymphony.workflow.soap.BasicSOAPWorkflow
public class BasicSOAPWorkflow
Soap enabled Wrapper around a BasicWorkflow
| Field Summary |
|---|
| Fields inherited from interface com.opensymphony.workflow.Workflow |
|---|
BSF_COL, BSF_LANGUAGE, BSF_ROW, BSF_SCRIPT, BSF_SOURCE, BSH_SCRIPT, CLASS_NAME, EJB_LOCATION, JNDI_LOCATION |
| Constructor Summary | |
|---|---|
BasicSOAPWorkflow()
|
|
| Method Summary | |
|---|---|
boolean |
canInitialize(String workflowName,
int initialState)
Check if the calling user has enough permissions to initialise the specified workflow. |
boolean |
canInitialize(String workflowName,
int initialAction,
Map inputs)
Determine if a particular workflow can be initialized. |
boolean |
canModifyEntryState(long id,
int newState)
Check if the state of the specified workflow instance can be changed to the new specified one. |
void |
changeEntryState(long id,
int newState)
Modify the state of the specified workflow instance. |
void |
doAction(long id,
int actionId,
Map inputs)
Perform an action on the specified workflow instance. |
void |
executeTriggerFunction(long id,
int triggerId)
Executes a special trigger-function using the context of the given workflow instance id. |
int[] |
getAvailableActions(long id)
|
int[] |
getAvailableActions(long id,
Map inputs)
Get the available actions for the specified workflow instance. |
List |
getCurrentSteps(long id)
Returns a Collection of Step objects that are the current steps of the specified workflow instance. |
int |
getEntryState(long id)
Return the state of the specified workflow instance id. |
List |
getHistorySteps(long id)
Returns a list of all steps that are completed for the given workflow instance id. |
com.opensymphony.module.propertyset.PropertySet |
getPropertySet(long id)
Get the PropertySet for the specified workflow instance id. |
protected String |
getRemoteUser()
|
List |
getSecurityPermissions(long id)
Get a collection (Strings) of currently defined permissions for the specified workflow instance. |
List |
getSecurityPermissions(long id,
Map inputs)
Get a collection (Strings) of currently defined permissions for the specified workflow instance. |
WorkflowDescriptor |
getWorkflowDescriptor(String workflowName)
Get the workflow descriptor for the specified workflow name. |
String |
getWorkflowName(long id)
Get the name of the specified workflow instance. |
String[] |
getWorkflowNames()
Get all available workflow names. |
long |
initialize(String workflowName,
int initialState,
Map inputs)
Initializes a workflow so that it can begin processing. |
List |
query(WorkflowExpressionQuery query)
Query the workflow store for matching instances |
List |
query(WorkflowQuery query)
Query the workflow store for matching instances |
boolean |
removeWorkflowDescriptor(String workflowName)
Remove the specified workflow descriptor. |
boolean |
saveWorkflowDescriptor(String workflowName,
WorkflowDescriptor descriptor,
boolean replace)
Add a new workflow descriptor |
void |
setConfiguration(Configuration configuration)
Set the configuration for this workflow. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BasicSOAPWorkflow()
| Method Detail |
|---|
public int[] getAvailableActions(long id)
getAvailableActions in interface Workflow
public int[] getAvailableActions(long id,
Map inputs)
Workflow
getAvailableActions in interface Workflowid - The workflow instance id.inputs - The inputs map to pass on to conditions
public void setConfiguration(Configuration configuration)
Workflow
setConfiguration in interface Workflowconfiguration - a workflow configurationpublic List getCurrentSteps(long id)
Workflow
getCurrentSteps in interface Workflowid - The workflow instance id.
public int getEntryState(long id)
Workflow
getEntryState in interface Workflowid - The workflow instance id.
public List getHistorySteps(long id)
Workflow
getHistorySteps in interface Workflowid - The workflow instance id.
Steppublic com.opensymphony.module.propertyset.PropertySet getPropertySet(long id)
Workflow
getPropertySet in interface Workflowid - The workflow instance id.public List getSecurityPermissions(long id)
Workflow
getSecurityPermissions in interface Workflowid - the workflow instance id.
public List getSecurityPermissions(long id,
Map inputs)
Workflow
getSecurityPermissions in interface Workflowid - id the workflow instance id.inputs - inputs The inputs to the workflow instance.
public WorkflowDescriptor getWorkflowDescriptor(String workflowName)
Workflow
getWorkflowDescriptor in interface WorkflowworkflowName - The workflow name.public String getWorkflowName(long id)
Workflow
getWorkflowName in interface Workflowid - the workflow instance id.public String[] getWorkflowNames()
Workflow
getWorkflowNames in interface Workflow
public boolean canInitialize(String workflowName,
int initialState)
Workflow
canInitialize in interface WorkflowworkflowName - The name of the workflow to check.initialState - The id of the initial state to check.
public boolean canInitialize(String workflowName,
int initialAction,
Map inputs)
Workflow
canInitialize in interface WorkflowworkflowName - The workflow name to check.initialAction - The potential initial action.inputs - The inputs to check.
public boolean canModifyEntryState(long id,
int newState)
Workflow
canModifyEntryState in interface Workflowid - The workflow instance id.newState - The new state id.
public void changeEntryState(long id,
int newState)
throws WorkflowException
Workflow
changeEntryState in interface Workflowid - The workflow instance id.newState - the new state to change the workflow instance to.
If the new state is com.opensymphony.workflow.spi.WorkflowEntry.KILLED
or com.opensymphony.workflow.spi.WorkflowEntry.COMPLETED
then all current steps are moved to history steps. If the new state is
WorkflowException
public void doAction(long id,
int actionId,
Map inputs)
throws WorkflowException
Workflow
doAction in interface Workflowid - The workflow instance id.actionId - The action id to perform (action id's are listed in the workflow descriptor).inputs - The inputs to the workflow instance.
InvalidInputException - if a validator is specified and an input is invalid.
WorkflowException
public void executeTriggerFunction(long id,
int triggerId)
throws WorkflowException
Workflow
executeTriggerFunction in interface Workflowid - The workflow instance idtriggerId - The id of the speciail trigger-function
WorkflowException
public long initialize(String workflowName,
int initialState,
Map inputs)
throws WorkflowException
Workflow
initialize in interface WorkflowworkflowName - The workflow name to create and initialize an instance forinitialState - The initial step to start the workflowinputs - The inputs entered by the end-user
InvalidRoleException - if the user can't start this function
InvalidInputException - if a validator is specified and an input is invalid.
WorkflowException
public List query(WorkflowQuery query)
throws StoreException
Workflow
query in interface WorkflowStoreException
public List query(WorkflowExpressionQuery query)
throws WorkflowException
Workflow
query in interface WorkflowWorkflowException
public boolean removeWorkflowDescriptor(String workflowName)
throws FactoryException
Workflow
removeWorkflowDescriptor in interface WorkflowworkflowName - The workflow name of the workflow to remove.
FactoryException - If the underlying workflow factory has an error removing the workflow,
or if it does not support the removal of workflows.
public boolean saveWorkflowDescriptor(String workflowName,
WorkflowDescriptor descriptor,
boolean replace)
throws FactoryException
Workflow
saveWorkflowDescriptor in interface WorkflowworkflowName - The workflow name of the workflow to adddescriptor - The workflow descriptor to addreplace - true, if an existing descriptor should be overwritten
FactoryException - If the underlying workflow factory has an error adding the workflow,
or if it does not support adding workflows.protected String getRemoteUser()
|
OpenSymphony Workflow Project Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||