Package org.kie.api.runtime.process

Interface WorkItemManager

  • 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void abortWorkItem​(long id)
      Notifies the work item manager that the work item with the given id could not be executed and should be aborted.
      void completeWorkItem​(long id, java.util.Map<java.lang.String,​java.lang.Object> results)
      Notifies the work item manager that the work item with the given id has been completed.
      void registerWorkItemHandler​(java.lang.String workItemName, WorkItemHandler handler)
      Register the given handler for all work items of the given type of work

    • Method Detail

      • completeWorkItem

        void completeWorkItem​(long id,
                      java.util.Map<java.lang.String,​java.lang.Object> results)
        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​(long id)
        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​(java.lang.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