Package com.sas.lsaf.workflow.processdefinition

Class ProcessDefinitionInfo

java.lang.Object
com.sas.lsaf.core.AbstractIdentifiable
com.sas.lsaf.workflow.processdefinition.ProcessDefinitionInfo
All Implemented Interfaces:
Identifiable, Serializable
public class ProcessDefinitionInfo extends AbstractIdentifiable
The class that specifies information about the process flow definition that was used to create a process flow.
See Also:

  • Constructor Details

    • ProcessDefinitionInfo

      public ProcessDefinitionInfo(String id, String processDefinitionKey, String name, String description, String deployedVersion, String definitionFilePath, String definitionFileVersion, Set<String> contextTypes, ProcessDefinitionInfo.ProcessDefinitionStatus status, String comment)
      It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the process flow definitions returned by the API.
      Parameters:
      id - The unique identifier of the process flow definition.
      processDefinitionKey - The key of the process flow definition, which is the same as the identifier in the definition file.
      name - The name of the process flow definition.
      description - The description of the process flow definition.
      deployedVersion - The latest deployed version of the process flow definition.
      definitionFilePath - The path of the file that was used to deploy the process flow definition.
      definitionFileVersion - The version of the file that was used to deploy the process flow definition.
      contextTypes - The context type identifiers in which process flows can be created with the process flow definition.
      status - The status of the process flow definition.
      comment - The comment that was specified when the process flow definition was deployed.

  • Method Details

    • getProcessDefinitionKey

      public String getProcessDefinitionKey()
      Gets the identifier of the process flow definition as it exists in the definition file.
      Returns:
      The identifier.

    • getName

      public String getName()
      Gets the name of the process flow definition.
      Returns:
      The name.

    • getDescription

      public String getDescription()
      Gets the description of the process flow definition.
      Returns:
      The description.

    • getDeployedVersion

      public String getDeployedVersion()
      Gets the deployed version of the process flow definition. This typically represents the number of times it has been deployed. See definitionFileVersion for the version of the repository file that was used to deploy the process flow definition.
      Returns:
      The deployed version.

    • getDefinitionFilePath

      public String getDefinitionFilePath()
      Gets the source path of the repository file that was used to deploy the process flow definition.
      Returns:
      The source path.

    • getDefinitionFileVersion

      public String getDefinitionFileVersion()
      Gets the version of the process flow definition file in the repository that was used to deploy the process.
      Returns:
      The version.

    • getContextTypes

      public Set<String> getContextTypes()
      Gets the context type identifiers for the types in which the process flow definition can be used to create process flows.
      Returns:
      The context type identifiers.

    • getStatus

      public ProcessDefinitionInfo.ProcessDefinitionStatus getStatus()
      Gets the status of the process flow definition. Only if the status is ACTIVE can process flows be created from the definition.
      Returns:
      The process flow definition status.

    • getComment

      public String getComment()
      Gets the comment that was specified when the process flow definition was deployed.
      Returns:
      The comment.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractIdentifiable

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class AbstractIdentifiable