Package org.sterl.pmw

Interface WorkflowService<RegistryType>

All Known Implementing Classes:

AbstractWorkflowService, PersistentWorkflowService

public interface WorkflowService<RegistryType>

Method Summary

Modifier and Type	Method	Description
void	cancel(RunningWorkflowId runningWorkflowId)
void	clearAllWorkflows()	Clear all running and registered workflows, mainly used in tests
RunningWorkflowId	execute(String workflowId)
RunningWorkflowId	execute(String workflowId, Serializable state)
RunningWorkflowId	execute(String workflowId, Serializable state, Duration delay)
<T extends Serializable> RunningWorkflowId	execute(Workflow<T> workflow)
<T extends Serializable> RunningWorkflowId	execute(Workflow<T> workflow, T state)
<T extends Serializable> RunningWorkflowId	execute(Workflow<T> workflow, T state, Duration delay)
Optional<String>	getWorkflowId(Workflow<?> workflow)
Collection<WorkflowInfo>	listWorkflows()
<T extends Serializable> RegistryType	register(String id, Workflow<T> workflow)	Should register a new workflow or throw an exception if the workflow is already known.
<T extends Serializable> boolean	resume(String runnngStepId, Function<T,T> stateModifier)	Resumes the waiting step of the an unknown workflow - ensure error handling in case of a wrong ID and so class cast exceptions
<T extends Serializable> boolean	resume(Workflow<T> workflow, String runnngStepId, Function<T,T> stateModifier)	Resumes the waiting step of the given workflow
org.sterl.spring.persistent_tasks.api.TriggerStatus	status(RunningWorkflowId runningWorkflowId)
int	workflowCount()	Count of known workflows

Method Details

listWorkflows

Collection<WorkflowInfo> listWorkflows()

execute

RunningWorkflowId execute(String workflowId)

execute

RunningWorkflowId execute(String workflowId,
 Serializable state)

execute

RunningWorkflowId execute(String workflowId,
 Serializable state,
 Duration delay)

execute

<T extends Serializable> RunningWorkflowId execute(Workflow<T> workflow)

execute

<T extends Serializable> RunningWorkflowId execute(Workflow<T> workflow,
 T state)

execute

<T extends Serializable> RunningWorkflowId execute(Workflow<T> workflow,
 T state,
 Duration delay)

status

org.sterl.spring.persistent_tasks.api.TriggerStatus status(RunningWorkflowId runningWorkflowId)

cancel

void cancel(RunningWorkflowId runningWorkflowId)

getWorkflowId

Optional<String> getWorkflowId(Workflow<?> workflow)

clearAllWorkflows

void clearAllWorkflows()

Clear all running and registered workflows, mainly used in tests

register

<T extends Serializable> RegistryType register(String id,
 Workflow<T> workflow)
                                        throws IllegalStateException

Should register a new workflow or throw an exception if the workflow is already known.

Throws:

IllegalStateException - if the workflow is already known

workflowCount

int workflowCount()

Count of known workflows

resume

<T extends Serializable> boolean resume(Workflow<T> workflow,
 String runnngStepId,
 Function<T,T> stateModifier)

Resumes the waiting step of the given workflow

resume

<T extends Serializable> boolean resume(String runnngStepId,
 Function<T,T> stateModifier)

Resumes the waiting step of the an unknown workflow - ensure error handling in case of a wrong ID and so class cast exceptions