Package com.broadleafcommerce.workflow.domain

Class Workflow

java.lang.Object
com.broadleafcommerce.workflow.domain.Workflow
public class Workflow extends Object
Represents a single execution of a SimpleWorkflow bean.

  • Constructor Details

    • Workflow

      public Workflow()

    • Workflow

      public Workflow(String id, String name, String description, String status, com.broadleafcommerce.data.tracking.core.filtering.domain.BasicAudit basicAudit, Set<ContextValue> contextValues, String lastException, String launchToken, String reference)

  • Method Details

    • getId

      public String getId()
      Primary key

    • getName

      public String getName()
      The name of the workflow. Must match the Spring bean name.

    • getDescription

      public String getDescription()
      Short description of the purpose of the workflow

    • getStatus

      public String getStatus()
      The status of execution of the workflow. See WorkflowStatus.

    • getBasicAudit

      public com.broadleafcommerce.data.tracking.core.filtering.domain.BasicAudit getBasicAudit()
      Audit information regarding creation and update author and timestamp

    • getContextValues

      public Set<ContextValue> getContextValues()
      Key/Value pairs used to inform the logic performed during workflow execution

    • getLastException

      public String getLastException()
      The most recent exception that took place during a previous workflow execution.

    • getLaunchToken

      public String getLaunchToken()
      Token associated with the workflow to correlate with messaging. See Informational.getLaunchToken().

    • getReference

      public String getReference()
      Optional. A reference value to which this workflow is correlated. The system will not start more than one workflow for a given reference value. The value must be less than or equal to 36 chars in length. Usually a ULID primary key for an entity.

    • setId

      public void setId(String id)
      Primary key

    • setName

      public void setName(String name)
      The name of the workflow. Must match the Spring bean name.

    • setDescription

      public void setDescription(String description)
      Short description of the purpose of the workflow

    • setStatus

      public void setStatus(String status)
      The status of execution of the workflow. See WorkflowStatus.

    • setBasicAudit

      public void setBasicAudit(com.broadleafcommerce.data.tracking.core.filtering.domain.BasicAudit basicAudit)
      Audit information regarding creation and update author and timestamp

    • setContextValues

      public void setContextValues(Set<ContextValue> contextValues)
      Key/Value pairs used to inform the logic performed during workflow execution

    • setLastException

      public void setLastException(String lastException)
      The most recent exception that took place during a previous workflow execution.

    • setLaunchToken

      public void setLaunchToken(String launchToken)
      Token associated with the workflow to correlate with messaging. See Informational.getLaunchToken().

    • setReference

      public void setReference(String reference)
      Optional. A reference value to which this workflow is correlated. The system will not start more than one workflow for a given reference value. The value must be less than or equal to 36 chars in length. Usually a ULID primary key for an entity.

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object