Class NodeKey

java.lang.Object
de.xima.fc.workflow.NodeKey
All Implemented Interfaces:
IUuidProviding, Serializable
public final class NodeKey extends Object implements IUuidProviding, Serializable
The key of a workflow node that uniquely identifies it within the context of a process. Consists of the node'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

    • getTaskUuid

      @Nullable @Deprecated public UUID getTaskUuid()
      Deprecated.
      Not used anymore, just the getUuid() already uniquely identifies the node. 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 node 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 node.
      Sets the legacy task UUID. This was used in older versions, but now only exists for backwards compatibility. The node 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.

    • getType

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

    • getUuid

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

    • 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 node key.

    • toString

      public String toString()
      Converts this node with name to a string reflecting the data of this POJO. Required for the omnifaces.SelectItemsConverter
      Overrides:
      toString in class Object

    • of

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

    • of

      public static NodeKey of(WorkflowNode node)
      Parameters:
      node - Node for which to get a key.
      Returns:
      A new node key for a node in the given task.

    • of

      public static NodeKey of(UUID nodeUuid)
      Parameters:
      nodeUuid - UUID of the node.
      Returns:
      A new node key for a node in the given task.

    • of

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