AmetysWorkflowStore (Ametys 4.4.x - API)

All Superinterfaces:

com.opensymphony.workflow.spi.WorkflowStore

All Known Implementing Classes:

AbstractJackrabbitWorkflowStore, AmetysObjectWorkflowStore, AvalonJackrabbitWorkflowStore, DefaultWspAvalonJackrabbitWorkflowStore, GenericWorkflowStore, JdbcWorkflowStore, WebAmetysObjectWorkflowStore, WebGenericWorkflowStore
```
public interface AmetysWorkflowStore
extends com.opensymphony.workflow.spi.WorkflowStore
```
WorkflowStore which does not keep instances once they are finished.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearHistory(long entryId)`	Removes all history steps of an instance from the database. All future calls to the history will return an empty List of Step.
`void`	`deleteInstance(long entryId)`	Deletes a workflow instance from the database. All future calls from the workflow to this instance will failed.
`boolean`	`shouldClearHistory()`	Returns true if the history steps have to be removed when the workflow reaches its final step

Methods inherited from interface com.opensymphony.workflow.spi.WorkflowStore
createCurrentStep, createEntry, findCurrentSteps, findEntry, findHistorySteps, getPropertySet, init, markFinished, moveToHistory, query, query, setEntryState

- Method Detail
  - shouldClearHistory
```
boolean shouldClearHistory()
```
    Returns true if the history steps have to be removed when the workflow reaches its final step
    
    Returns:
    
    true if the history history has to be cleared.
  - deleteInstance
```
void deleteInstance(long entryId)
             throws com.opensymphony.workflow.StoreException
```
    Deletes a workflow instance from the database.
    All future calls from the workflow to this instance will failed.
    
    Parameters:
    
    entryId - The id of a workflow instance.
    
    Throws:
    
    com.opensymphony.workflow.StoreException - if an error occurs.
  - clearHistory
```
void clearHistory(long entryId)
           throws com.opensymphony.workflow.StoreException
```
    Removes all history steps of an instance from the database.
    All future calls to the history will return an empty List of Step.
    
    Parameters:
    
    entryId - the id of a workflow instance.
    
    Throws:
    
    com.opensymphony.workflow.StoreException - if an error occurs.