Package io.automatiko.engine.api.runtime.process

Interface WorkItemManager

All Known Subinterfaces:

InternalWorkItemManager

public interface WorkItemManager

A work item manager is responsible for finding the right work item handler when a work item should be executed and should be notified when this work item has been completed (or aborted).

Method Summary

Modifier and Type	Method	Description
void	abortWorkItem(String id, Policy<?>... policies)	Notifies the work item manager that the work item with the given id could not be executed and should be aborted.
void	completeWorkItem(String id, Map<String,Object> results, Policy<?>... policies)	Notifies the work item manager that the work item with the given id has been completed.
void	dispose()
void	registerWorkItemHandler(String workItemName, WorkItemHandler handler)	Register the given handler for all work items of the given type of work
void	retryWorkItem(String workItemID, Map<String,Object> params)
default void	transitionWorkItem(String id, Transition<?> transition)	Transition work item with given id into the next life cycle phase.

Method Detail

completeWorkItem

void completeWorkItem(String id,
                      Map<String,Object> results,
                      Policy<?>... policies)

Notifies the work item manager that the work item with the given id has been completed. Results related to the execution of this work item can be passed.

Parameters:

id - the id of the work item that has been completed

results - the results related to this work item, or null if there are no results

abortWorkItem

void abortWorkItem(String id,
                   Policy<?>... policies)

Notifies the work item manager that the work item with the given id could not be executed and should be aborted.

Parameters:

id - the id of the work item that should be aborted

registerWorkItemHandler

void registerWorkItemHandler(String workItemName,
                             WorkItemHandler handler)

Register the given handler for all work items of the given type of work

Parameters:

workItemName - the type of work this work item handler can execute

handler - the handler for executing work items

transitionWorkItem

default void transitionWorkItem(String id,
                                Transition<?> transition)

Transition work item with given id into the next life cycle phase.

Parameters:

id - work item id to be transitioned

transition - actual transition to apply to work item

dispose

void dispose()

retryWorkItem

void retryWorkItem(String workItemID,
                   Map<String,Object> params)