Package ch.ivyteam.ivy.workflow.signal

Interface ISignalEvent

  • public interface ISignalEvent
    A signal event that was sent.
    Since:
    6.1.0
    API:
    This is a public API.

    • Method Detail

      • getId

        long getId()
        Returns:
        The id of the signal event.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSignalCode

        SignalCode getSignalCode()
        Returns:
        The code of the signal that was sent.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSignalData

        Object getSignalData()
        Returns:
        The signal data that was sent. null when no data was sent.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSentTimestamp

        Date getSentTimestamp()
        Returns:
        The timestamp when the signal was sent.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSentByProcessElementId

        PID getSentByProcessElementId()
        Returns:
        The PID of the process element that sent the signal. Maybe null.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSentByTask

        ITask getSentByTask()
        Returns:
        The task that was running when the signal was sent. Maybe null.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSentByUser

        IUser getSentByUser()
        Returns:
        The user that was logged in when the signal was sent. Maybe null.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getSentByUserName

        String getSentByUserName()
        Returns:
        The username of the user that was logged in when the signal was sent. Maybe null.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getCreatedTasks

        List<ITask> getCreatedTasks()
        Returns:
        The tasks that were created through this signal.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getDestroyedTasks

        List<ITask> getDestroyedTasks()
        Returns:
        The tasks that were destroyed through this signal.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.