|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface WorkflowStore
Interface for pluggable workflow stores configured in osworkflow.xml. Only one instance of a workflow store is ever created, meaning that if your persistence connections (such as java.sql.Connection) time out, it would be un-wise to use just one Connection for the entire object.
| Method Summary | |
|---|---|
Step |
createCurrentStep(long entryId,
int stepId,
String owner,
Date startDate,
Date dueDate,
String status,
long[] previousIds)
Persists a step with the given parameters. |
WorkflowEntry |
createEntry(String workflowName)
Persists a new workflow entry that has not been initialized. |
List |
findCurrentSteps(long entryId)
Returns a list of all current steps for the given workflow instance ID. |
WorkflowEntry |
findEntry(long entryId)
Pulls up the workflow entry data for the entry ID given. |
List |
findHistorySteps(long entryId)
Returns a list of all steps that are finished for the given workflow instance ID. |
com.opensymphony.module.propertyset.PropertySet |
getPropertySet(long entryId)
Returns a PropertySet that is associated with this workflow instance ID. |
void |
init(Map props)
Called once when the store is first created. |
Step |
markFinished(Step step,
int actionId,
Date finishDate,
String status,
String caller)
Mark the specified step as finished. |
void |
moveToHistory(Step step)
Called when a step is finished and can be moved to workflow history. |
List |
query(WorkflowExpressionQuery query)
|
List |
query(WorkflowQuery query)
Deprecated. use query(WorkflowExpressionQuery) instead. |
void |
setEntryState(long entryId,
int state)
Set the state of the workflow instance. |
| Method Detail |
|---|
void setEntryState(long entryId,
int state)
throws StoreException
entryId - The workflow instance id.state - The state to move the workflow instance to.
StoreException
com.opensymphony.module.propertyset.PropertySet getPropertySet(long entryId)
throws StoreException
entryId - The workflow instance id.
StoreException
Step createCurrentStep(long entryId,
int stepId,
String owner,
Date startDate,
Date dueDate,
String status,
long[] previousIds)
throws StoreException
entryId - The workflow instance id.stepId - the ID of the workflow step associated with this new
Step (not to be confused with the step primary key)owner - the owner of the stepstartDate - the start date of the stepstatus - the status of the steppreviousIds - the previous step IDs
StoreException
WorkflowEntry createEntry(String workflowName)
throws StoreException
workflowName - the workflow name that this entry is an instance of
StoreException
List findCurrentSteps(long entryId)
throws StoreException
entryId - The workflow instance id.
StoreExceptionStep
WorkflowEntry findEntry(long entryId)
throws StoreException
entryId - The workflow instance id.
StoreException
List findHistorySteps(long entryId)
throws StoreException
entryId - The workflow instance id.
StoreExceptionStep
void init(Map props)
throws StoreException
props - properties set in osworkflow.xml
StoreException
Step markFinished(Step step,
int actionId,
Date finishDate,
String status,
String caller)
throws StoreException
step - the step to finish.actionId - The action that caused the step to finish.finishDate - the date when the step was finished.status - The status to set the finished step to.caller - The caller that caused the step to finish.
StoreException
void moveToHistory(Step step)
throws StoreException
step - the step to be moved to workflow history
StoreException
List query(WorkflowQuery query)
throws StoreException
query(WorkflowExpressionQuery) instead.
query - the query to use
StoreException
List query(WorkflowExpressionQuery query)
throws StoreException
query - the query to use
StoreException
|
OpenSymphony Workflow Project Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||