| com.opensymphony.workflow.spi.WorkflowStore
All known Subclasses: com.opensymphony.workflow.spi.jdbc.JDBCWorkflowStore, com.opensymphony.workflow.spi.prevayler.PrevaylerWorkflowStore, com.opensymphony.workflow.spi.memory.MemoryWorkflowStore, com.opensymphony.workflow.spi.ejb.EJBWorkflowStore, com.opensymphony.workflow.spi.ofbiz.OfbizWorkflowStore, com.opensymphony.workflow.spi.hibernate.HibernateWorkflowStore, com.opensymphony.workflow.spi.hibernate.AbstractHibernateWorkflowStore, com.opensymphony.workflow.spi.ojb.OJBWorkflowStore, com.opensymphony.workflow.spi.hibernate3.AbstractHibernateWorkflowStore, com.opensymphony.workflow.spi.hibernate.SpringHibernateWorkflowStore, com.opensymphony.workflow.spi.prevayler.WorkflowSystem,
| WorkflowStore | | public interface WorkflowStore (Code) | | 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.
author:
Pat Lightbody |
| Method Summary | |
| public Step | createCurrentStep(long entryId, int stepId, String owner, Date startDate, Date dueDate, String status, long[] previousIds)
Persists a step with the given parameters. | | public WorkflowEntry | createEntry(String workflowName)
Persists a new workflow entry that has not been initialized. | | public List | findCurrentSteps(long entryId)
Returns a list of all current steps for the given workflow instance ID.
Parameters:
entryId - The workflow instance id. | | public WorkflowEntry | findEntry(long entryId)
Pulls up the workflow entry data for the entry ID given.
Parameters:
entryId - The workflow instance id. | | public List | findHistorySteps(long entryId)
Returns a list of all steps that are finished for the given workflow instance ID.
Parameters:
entryId - The workflow instance id. | | public PropertySet | getPropertySet(long entryId)
Returns a PropertySet that is associated with this workflow instance ID.
Parameters:
entryId - The workflow instance id. | | public void | init(Map props)
Called once when the store is first created. | | public Step | markFinished(Step step, int actionId, Date finishDate, String status, String caller)
Mark the specified step as finished.
Parameters:
step - the step to finish.
Parameters:
actionId - The action that caused the step to finish.
Parameters:
finishDate - the date when the step was finished.
Parameters:
status - The status to set the finished step to.
Parameters:
caller - The caller that caused the step to finish. | | public void | moveToHistory(Step step)
Called when a step is finished and can be moved to workflow history. | | public List | query(WorkflowQuery query)
| | public List | query(WorkflowExpressionQuery query)
| | public void | setEntryState(long entryId, int state)
Set the state of the workflow instance. |
| createCurrentStep | | public Step createCurrentStep(long entryId, int stepId, String owner, Date startDate, Date dueDate, String status, long[] previousIds) throws StoreException(Code) | | Persists a step with the given parameters.
Parameters:
entryId - The workflow instance id.
Parameters:
stepId - the ID of the workflow step associated with this newStep (not to be confused with the step primary key)
Parameters:
owner - the owner of the step
Parameters:
startDate - the start date of the step
Parameters:
status - the status of the step
Parameters:
previousIds - the previous step IDs a representation of the workflow step persisted |
| createEntry | | public WorkflowEntry createEntry(String workflowName) throws StoreException(Code) | | Persists a new workflow entry that has not been initialized.
Parameters:
workflowName - the workflow name that this entry is an instance of a representation of the workflow instance persisted |
| findEntry | | public WorkflowEntry findEntry(long entryId) throws StoreException(Code) | | Pulls up the workflow entry data for the entry ID given.
Parameters:
entryId - The workflow instance id. a representation of the workflow instance persisted |
| getPropertySet | | public PropertySet getPropertySet(long entryId) throws StoreException(Code) | | Returns a PropertySet that is associated with this workflow instance ID.
Parameters:
entryId - The workflow instance id. a property set unique to this entry ID |
| init | | public void init(Map props) throws StoreException(Code) | | Called once when the store is first created.
Parameters:
props - properties set in osworkflow.xml |
| markFinished | | public Step markFinished(Step step, int actionId, Date finishDate, String status, String caller) throws StoreException(Code) | | Mark the specified step as finished.
Parameters:
step - the step to finish.
Parameters:
actionId - The action that caused the step to finish.
Parameters:
finishDate - the date when the step was finished.
Parameters:
status - The status to set the finished step to.
Parameters:
caller - The caller that caused the step to finish. the finished step |
| moveToHistory | | public void moveToHistory(Step step) throws StoreException(Code) | | Called when a step is finished and can be moved to workflow history.
Parameters:
step - the step to be moved to workflow history |
| setEntryState | | public void setEntryState(long entryId, int state) throws StoreException(Code) | | Set the state of the workflow instance.
Parameters:
entryId - The workflow instance id.
Parameters:
state - The state to move the workflow instance to. |
|
|