Package ch.ivyteam.ivy.workflow

Interface IIntermediateEvent

public interface IIntermediateEvent
An intermediate event
Since:
30.01.2008
API:
This is a public API.

  • Method Details

    • getIntermediateEventElement

      IIntermediateEventElement getIntermediateEventElement()
      Gets the intermediate event element. May be null if intermediate event element was deleted
      Returns:
      intermediate event element or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventElementRead PERMISSION OR OWNS IntermediateEventElementRead@SYSTEM PERMISSION

    • getTaskStart

      ITaskStart getTaskStart()
      Gets the task start
      Returns:
      task start
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • getEventIdentifier

      String getEventIdentifier()
      Gets the event identifier
      Returns:
      event identifier
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadEventIdentifier PERMISSION OR OWNS IntermediateEventReadEventIdentifier@SYSTEM PERMISSION

    • getId

      long getId()
      Gets the identifier of the intermediate event
      Returns:
      identifier
      API:
      This public API is available in Java.

    • getResultObject

      Object getResultObject()
      Gets the result object of the intermediate event. This object holds information about the event.
      Returns:
      result object or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadResultObject PERMISSION OR OWNS IntermediateEventReadResultObject@SYSTEM PERMISSION

    • getTask

      ITask getTask()
      Gets the task that is waiting for or has been waiting for the event. Maybe null if the event has been received but no task is yet waiting for the event.
      Returns:
      task or null.
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS TaskRead PERMISSION OR OWNS TaskRead@SYSTEM PERMISSION

    • getEventTimestamp

      Date getEventTimestamp()
      Gets the time the event has been received. Maybe null if the event was not yet received
      Returns:
      event timestamp or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadEventTimestamp PERMISSION OR OWNS IntermediateEventReadEventTimestamp@SYSTEM PERMISSION

    • getState

      IntermediateEventState getState()
      The state of the event
      Returns:
      state
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadState PERMISSION OR OWNS IntermediateEventReadState@SYSTEM PERMISSION

    • getTimeoutAction

      IntermediateEventTimeoutAction getTimeoutAction()
      Gets the timeout action that should be executed if a timeout occurs
      Returns:
      timeout action
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadTimeoutAction PERMISSION OR OWNS IntermediateEventReadTimeoutAction@SYSTEM PERMISSION

    • getTimeoutTimestamp

      Date getTimeoutTimestamp()
      Gets the timeout timestamp. Maybe null if no timeout is defined
      Returns:
      timeout timestamp or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadTimeoutTimestamp PERMISSION OR OWNS IntermediateEventReadTimeoutTimestamp@SYSTEM PERMISSION

    • getTimeoutTaskStartElementId

      String getTimeoutTaskStartElementId()
      Gets the start element id where the timeout exception task should be started on if a timeout occurs. Maybe null if no exception task is defined
      Returns:
      timeout exception task start element id
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadTimeoutTaskStartElementId PERMISSION OR OWNS IntermediateEventReadTimeoutTaskStartElementId@SYSTEM PERMISSION

    • getAdditionalInformation

      String getAdditionalInformation()
      Gets additional information about the event. Null if the event has not yet been received.
      Returns:
      additional information or null
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventReadAdditionalInformation PERMISSION OR OWNS IntermediateEventReadAdditionalInformation@SYSTEM PERMISSION

    • setTimeoutTimestamp

      void setTimeoutTimestamp(Date timeoutTimestamp)

      Sets the timeout timestamp. The state will be set to IntermediateEventState.TIMEOUTED if the new timeout timestamp is in the past.

      Setting the timeout timestamp is only allowed when in state IntermediateEventState.WAITING

      Parameters:
      timeoutTimestamp - the timeout timestamp
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS IntermediateEventWriteTimeoutTimestamp PERMISSION OR OWNS IntermediateEventWriteTimeoutTimestamp@SYSTEM PERMISSION