Class GlobalTimerWorkflowEventHandler

java.lang.Object
de.uplanet.lucy.server.workflow.eventhandler.AbstractWorkflowEventHandler
de.uplanet.lucy.server.workflow.eventhandler.GlobalTimerWorkflowEventHandler
All Implemented Interfaces:
IActivatableWorkflowObject, INamedWorkflowObject, INeedWorkflow, IWorkflowEventHandler, IWorkflowObject, Serializable

public final class GlobalTimerWorkflowEventHandler extends AbstractWorkflowEventHandler
See Also:
  • Constructor Details

    • GlobalTimerWorkflowEventHandler

      public GlobalTimerWorkflowEventHandler(String p_strGuid)
  • Method Details

    • getTimerGuid

      public String getTimerGuid()
      Get the GUID of the associated global timer.
      Returns:
      The GUID of the associated global timer.
    • setTimerGuid

      public void setTimerGuid(String p_strTimerGuid)
      Set the GUID of the associated global timer.
      Parameters:
      p_strTimerGuid - The GUID of the associated global timer.
    • isHandlerFor

      public boolean isHandlerFor(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx)
      Description copied from interface: IWorkflowEventHandler
      Check if this event handler may handle the given event.

      This method should return false if this event handler's state is inactive.

      Note: despite this method returns true the event handler is not required to return its efferent transition when process is being called.

      Parameters:
      p_evt - The event.
      p_wfCtx - The workflow processing context.
      Returns:
      true if this event handler may process this event, or false otherwise.
    • process

      public WorkflowTransition process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) throws Exception
      Description copied from interface: IWorkflowEventHandler
      Process a workflow event in the given context.

      This method is called by the workflow engine if a call to isHandlerFor returned true. However this method is not required to return a non-null efferent transition in such cases.

      A workflow event handler must return null if it is not active.

      Parameters:
      p_evt - The event to be processed.
      p_wfCtx - The workflow processing context.
      p_ctx - The processing context.
      Returns:
      The efferent transition, or null.
      Throws:
      InterruptedException - If processing of this event handler has been interrupted.
      Exception - If an error occurred.