Package com.broadleafcommerce.workflow.provider.jpa.domain

Class JpaWorkflow

java.lang.Object
com.broadleafcommerce.workflow.provider.jpa.domain.JpaWorkflow
All Implemented Interfaces:
com.broadleafcommerce.common.messaging.notification.domain.NotificationStateAware, com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware, com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable, com.broadleafcommerce.data.tracking.core.TenantTrackable<com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking>, com.broadleafcommerce.data.tracking.core.Trackable, com.broadleafcommerce.data.tracking.core.TypedTrackable<com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking>, Informational, Serializable
@Entity public class JpaWorkflow extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable, com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware, com.broadleafcommerce.data.tracking.core.TenantTrackable<com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking>, Informational
See Also:

  • Constructor Details

    • JpaWorkflow

      public JpaWorkflow()

  • Method Details

    • fromMe

      @NonNull public org.modelmapper.ModelMapper fromMe()
      Specified by:
      fromMe in interface com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable

    • toMe

      @NonNull public org.modelmapper.ModelMapper toMe()
      Specified by:
      toMe in interface com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable

    • getBusinessDomainType

      public Class<?> getBusinessDomainType()
      Specified by:
      getBusinessDomainType in interface com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware

    • getContextId

      public String getContextId()
      Description copied from interface: Informational
      The context id of the workflow (primary key)
      Specified by:
      getContextId in interface Informational
      Specified by:
      getContextId in interface com.broadleafcommerce.data.tracking.core.Trackable
      Returns:
      The context id

    • getLaunchToken

      public String getLaunchToken()
      Description copied from interface: Informational
      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.
      Specified by:
      getLaunchToken in interface Informational
      Returns:
      Token associated with the workflow to correlate with messaging

    • getReference

      public String getReference()

    • getName

      public String getName()
      Description copied from interface: Informational
      The unique name identifier for this workflow. This name should match the Spring bean name for the SimpleWorkflow instance.
      Specified by:
      getName in interface Informational
      Returns:
      The unique name identifier for this workflow

    • getDescription

      public String getDescription()
      Description copied from interface: Informational
      A short description of the purpose of this workflow.
      Specified by:
      getDescription in interface Informational
      Returns:
      A short description of the purpose of this workflow

    • getStatus

      public String getStatus()
      Description copied from interface: Informational
      The status of the workflow. See WorkflowStatus.
      Specified by:
      getStatus in interface Informational
      Returns:
      The status of the workflow

    • getLastStepTimeout

      public Long getLastStepTimeout()

    • getLastStepName

      public String getLastStepName()

    • getLastException

      public String getLastException()
      Description copied from interface: Informational
      The most recent exception that took place during a previous workflow execution.
      Specified by:
      getLastException in interface Informational
      Returns:
      The most recent exception

    • getContextValues

      public Set<JpaContextValue> getContextValues()
      Description copied from interface: Informational
      Key/Value pairs of information passed to the workflow when it was started.
      Specified by:
      getContextValues in interface Informational
      Returns:
      Key/Value pairs of information

    • getTracking

      public com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking getTracking()
      Specified by:
      getTracking in interface com.broadleafcommerce.data.tracking.core.Trackable

    • setContextId

      public void setContextId(String contextId)
      Specified by:
      setContextId in interface com.broadleafcommerce.data.tracking.core.Trackable

    • setLaunchToken

      public void setLaunchToken(String launchToken)

    • setReference

      public void setReference(String reference)

    • setName

      public void setName(String name)

    • setDescription

      public void setDescription(String description)

    • setStatus

      public void setStatus(String status)
      Description copied from interface: Informational
      The status of the workflow. See WorkflowStatus.
      Specified by:
      setStatus in interface Informational
      Parameters:
      status - The status of the workflow

    • setLastStepTimeout

      public void setLastStepTimeout(Long lastStepTimeout)
      Description copied from interface: Informational
      The timestamp at which the workflow will have exceeded the timeout boundary for activity execution for the activity identified by Informational.setLastStepName(String).
      Specified by:
      setLastStepTimeout in interface Informational
      Parameters:
      lastStepTimeout - The timestamp at which the workflow will have exceeded the timeout boundary

    • setLastStepName

      public void setLastStepName(String lastStepName)
      Description copied from interface: Informational
      The name of the most recent activity that is presumed to be in-process
      Specified by:
      setLastStepName in interface Informational
      Parameters:
      lastStepName - The name of the most recent activity that is presumed to be in-process

    • setLastException

      public void setLastException(String lastException)
      Description copied from interface: Informational
      The most recent exception that took place during a previous workflow execution.
      Specified by:
      setLastException in interface Informational
      Parameters:
      lastException - The most recent exception

    • setContextValues

      public void setContextValues(Set<JpaContextValue> contextValues)

    • setTracking

      public void setTracking(com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking)
      Specified by:
      setTracking in interface com.broadleafcommerce.data.tracking.core.TypedTrackable<com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking>

    • 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