Class TriggerKey

java.lang.Object
de.xima.fc.workflow.TriggerKey
All Implemented Interfaces:
IUuidProviding, Serializable
public final class TriggerKey extends Object implements IUuidProviding, Serializable
The key of a workflow trigger that uniquely identifies it within the context of a process. Consists of the trigger's UUID.
Since:
7.0.0
Author:
XIMA MEDIA GmbH
See Also:

  • Method Details

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getType

      @Nullable public EWorkflowElementType getType()
      Gets the type of this key, always EWorkflowElementType.TRIGGER.
      Returns:
      The type of this key, always EWorkflowElementType.TRIGGER.

    • getTaskUuid

      @Nullable @Deprecated public UUID getTaskUuid()
      Deprecated.
      Not used anymore, just the getUuid() already uniquely identifies the trigger. This method will most likely return null.
      Gets the legacy task UUID, if available. This was used in older versions, but now only exists for backwards compatibility. The trigger UUID is already unique within the workflow, so the task UUID is not needed anymore.
      Returns:
      The legacy task UUID if available, null otherwise.

    • setTaskUuid

      public void setTaskUuid(UUID taskUuid)
      Deprecated.
      Not used anymore, just the getUuid() already uniquely identifies the trigger.
      Sets the legacy task UUID. This was used in older versions, but now only exists for backwards compatibility. The trigger UUID is already unique within the workflow, so the task UUID is not needed anymore.
      Parameters:
      taskUuid - The legacy task UUID to set, can be null.

    • getUuid

      public UUID getUuid()
      Gets the UUID of the referenced trigger.
      Specified by:
      getUuid in interface IUuidProviding
      Returns:
      The UUID of the trigger.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • stringValue

      public String stringValue()
      Returns:
      A string form of this key that can be parsed by of(String).

    • toElementKey

      public ElementKey toElementKey()
      Returns:
      An element key for this trigger key.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • of

      public static TriggerKey of(String value)
      Parameters:
      value - Value as obtained by stringValue().
      Returns:
      The key represented by the given string.

    • of

      public static TriggerKey of(UUID triggerUuid)
      Parameters:
      triggerUuid - UUID of the trigger.
      Returns:
      A new trigger key for a trigger in the given task.

    • of

      public static TriggerKey of(WorkflowTrigger trigger)
      Parameters:
      trigger - Trigger for which to get a key.
      Returns:
      A new trigger key for a trigger in the given task.

    • of

      @Deprecated public static TriggerKey of(UUID taskUuid, UUID triggerUuid)
      Deprecated.
      Use of(UUID) instead, the task UUID is not needed anymore and is ignored.
      Parameters:
      taskUuid - UUID of the task to which the trigger belongs.
      triggerUuid - UUID of the trigger.
      Returns:
      A new trigger key for a trigger in the given task.