Package ch.ivyteam.ivy.workflow.signal

Interface ITaskBoundarySignalEventReceiver

public interface ITaskBoundarySignalEventReceiver
A task with an attached Signal Boundary Event element that is waiting for a signal pattern.
Since:
6.1.0
API:
This is a public API.

  • Method Details

    • getSignalPattern

      SignalCode getSignalPattern()
      Returns:
      The signal pattern that the signal start is waiting for.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getWaitingTask

      ITask getWaitingTask()
      Returns:
      The task this signal receiver is waiting or has waited on.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getStartedSignaledTask

      ISignaledTask getStartedSignaledTask()
      Returns:
      The task that was started by the received signal.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getSignaledTaskTaskStart

      ITaskStart getSignaledTaskTaskStart()
      Returns:
      The task start where a task will be started if the signal is received.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • isWaitingForSignal

      boolean isWaitingForSignal()
      A task boundary signal event receiver waits on a signal if:
      • The signal is not yet received.
      • The attached task is not done or destroyed.
      Returns:
      true when the Signal Boundary Event element of this task is waiting for signals.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.