Package ch.ivyteam.ivy.workflow.signal

Interface IBpmSignalHistory

  • public interface IBpmSignalHistory
    Query sent signals.
    Since:
    6.1.0
    API:
    This is a public API.

    • Method Detail

      • createSignalEventQuery

        SignalEventQuery createSignalEventQuery()

        Query for sent signal events (ISignalEvent).

        Example: Get sent signal events, whose signal code starts with "admin:quit:".
         import ch.ivyteam.ivy.workflow.signal.ISignalEvent;
 List<ISignalEvent> signalEvents = ivy.wf.signals().history().createSignalEventQuery().where().signalCode().isLike("admin:quit:%").executor().results();
        Returns:
        a query that can be executed
        See Also:
        ISignalEvent
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • createTaskBoundaryQuery

        TaskBoundarySignalEventReceiverQuery createTaskBoundaryQuery()

        Query task signal boundary receivers that already have received a signal (ITaskBoundarySignalEventReceiver).

        Example: Get task signal boundary receivers whose signal code pattern starts with "admin:quit:%".
         import ch.ivyteam.ivy.workflow.signal.ITaskBoundarySignalEventReceiver;
 List<ITaskBoundarySignalEventReceiver> signalBoundaries = ivy.wf.signals().history().createTaskBoundaryQuery().where().signalCodePattern().isLike("admin:quit:%").executor().results();
        Returns:
        a query that can be executed
        See Also:
        ITaskBoundarySignalEventReceiver
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSignaledTask

        ISignaledTask getSignaledTask​(ITask task)
        Gets information about the signal that created the task
        Parameters:
        task -
        Returns:
        signaled task or null if task was not created by a signal
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.