Package com.broadleafcommerce.workflow.domain

Interface Informational

All Known Implementing Classes:
JpaWorkflow
public interface Informational
Provides property information about a workflow.

  • Method Details

    • getContextId

      String getContextId()
      The context id of the workflow (primary key)
      Returns:
      The context id

    • getStatus

      String getStatus()
      The status of the workflow. See WorkflowStatus.
      Returns:
      The status of the workflow

    • getName

      String getName()
      The unique name identifier for this workflow. This name should match the Spring bean name for the SimpleWorkflow instance.
      Returns:
      The unique name identifier for this workflow

    • getDescription

      String getDescription()
      A short description of the purpose of this workflow.
      Returns:
      A short description of the purpose of this workflow

    • getLastException

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

    • getLaunchToken

      String getLaunchToken()
      Token associated with the workflow to correlate with messaging. The same token is associated with a message requesting action on the workflow. At the time of consumption, if the token on the workflow does not match the token on the message, then the message is dropped, and it is assumed the state of the workflow changed with a new, forthcoming message.
      Returns:
      Token associated with the workflow to correlate with messaging

    • getContextValues

      Set<JpaContextValue> getContextValues()
      Key/Value pairs of information passed to the workflow when it was started.
      Returns:
      Key/Value pairs of information

    • setStatus

      void setStatus(String status)
      The status of the workflow. See WorkflowStatus.
      Parameters:
      status - The status of the workflow

    • setLastException

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

    • setLastStepName

      void setLastStepName(String lastStepName)
      The name of the most recent activity that is presumed to be in-process
      Parameters:
      lastStepName - The name of the most recent activity that is presumed to be in-process

    • setLastStepTimeout

      void setLastStepTimeout(Long timeout)
      The timestamp at which the workflow will have exceeded the timeout boundary for activity execution for the activity identified by setLastStepName(String).
      Parameters:
      timeout - The timestamp at which the workflow will have exceeded the timeout boundary