Package com.orchestranetworks.workflow

Class WorkflowStepMetadata

java.lang.Object
com.orchestranetworks.workflow.WorkflowStepMetadata
public final class WorkflowStepMetadata extends Object
Represents metadata for a workflow step. This class encapsulates information about the step's primary key, properties, and type. It also provides methods to manage and retrieve step-specific properties.
Since:
6.2.2

  • Constructor Details

    • WorkflowStepMetadata

      public WorkflowStepMetadata(PrimaryKey aPrimaryKey)
      Constructs a new WorkflowStepMetadata instance with the specified primary key.
      Parameters:
      aPrimaryKey - The primary key of the workflow step.

  • Method Details

    • getPrimaryKey

      public PrimaryKey getPrimaryKey()
      Retrieves the primary key of the workflow step.
      Returns:
      The primary key of the workflow step.

    • getType

      public WorkflowStepMetadata.Type getType()
      Retrieves the type of the workflow step.
      Returns:
      The type of the workflow step.

    • setType

      public void setType(WorkflowStepMetadata.Type type)
      Sets the type of the workflow step.
      Parameters:
      type - The type to set for the workflow step.

    • getProperties

      public Map<WorkflowStepMetadata.Property,Object> getProperties()
      Retrieves the properties associated with the workflow step.
      Returns:
      A map of properties associated with the workflow step.

    • getProperty

      public Object getProperty(WorkflowStepMetadata.Property key)
      Retrieves the value of a specific property.
      Parameters:
      key - The property key.
      Returns:
      The value of the specified property, or null if not set.

    • getStringProperty

      public String getStringProperty(WorkflowStepMetadata.Property key)
      Retrieves the value of a specific property as a string.
      Parameters:
      key - The property key.
      Returns:
      The value of the specified property as a string, or null if not set.

    • setProperty

      public void setProperty(WorkflowStepMetadata.Property key, Object value)
      Sets the value of a specific property.
      Parameters:
      key - The property key.
      value - The value to set for the property. If null, the property is removed.

    • setProperties

      public void setProperties(Map<WorkflowStepMetadata.Property,Object> properties)
      Sets multiple properties for the workflow step.
      Parameters:
      properties - A map of properties to set. If null, no properties are set.

    • getDocumentation

      public com.onwbp.base.text.bean.LabelDescription getDocumentation()
      Retrieves the label and description of the workflow step.
      Returns:
      The label and description of the workflow step.

    • setDocumentation

      public void setDocumentation(com.onwbp.base.text.bean.LabelDescription documentation)
      Sets the label and description of the workflow step.
      Parameters:
      documentation - The label and description to set for the workflow step.

    • equals

      public boolean equals(Object obj)
      Checks if this WorkflowStepMetadata is equal to another object.
      Overrides:
      equals in class Object
      Parameters:
      obj - The object to compare.
      Returns:
      True if the objects are equal, false otherwise.

    • hashCode

      public int hashCode()
      Computes the hash code for this WorkflowStepMetadata.
      Overrides:
      hashCode in class Object
      Returns:
      The hash code of the workflow step metadata.