Package com.broadleafcommerce.enterprise.workflow.domain

Interface WorkflowEvent

All Superinterfaces:
Serializable
All Known Implementing Classes:
WorkflowEventImpl
public interface WorkflowEvent extends Serializable
Represents a group of user sandbox changes that have been promoted to an approval sandbox.
Author:
Jeff Fischer

  • Method Details

    • getId

      Long getId()

    • setId

      void setId(Long id)

    • getName

      String getName()
      Descriptive name for the grouping
      Returns:
      descriptive name

    • setName

      void setName(String name)
      Descriptive name for the grouping
      Parameters:
      name - descriptive name

    • getMessage

      String getMessage()
      Optional message further describing the group
      Returns:
      descriptive message

    • setMessage

      void setMessage(String message)
      Optional message further describing the group
      Parameters:
      message - descriptive message

    • getActionType

      SandBoxActionType getActionType()
      Describes the action that caused this grouping to be created
      Returns:
      the causal agent

    • setActionType

      void setActionType(SandBoxActionType actionType)
      Describes the action that caused this grouping to be created
      Parameters:
      actionType - the causal agent

    • getArchivedFlag

      Boolean getArchivedFlag()
      Whether or not this grouping has been archived. Archived events are not displayed and are not selectable for deployment.
      Returns:
      archived status

    • setArchivedFlag

      void setArchivedFlag(Boolean archivedFlag)
      Whether or not this grouping has been archived. Archived events are not displayed and are not selectable for deployment.
      Parameters:
      archivedFlag - archived status

    • getAuthor

      org.broadleafcommerce.openadmin.server.security.domain.AdminUser getAuthor()
      The admin user that created this grouping
      Returns:
      the admin user

    • setAuthor

      void setAuthor(org.broadleafcommerce.openadmin.server.security.domain.AdminUser author)
      The admin user that created this grouping
      Parameters:
      author - the admin user

    • getSandBox

      org.broadleafcommerce.common.sandbox.domain.SandBox getSandBox()
      The sandbox to which this grouping belongs
      Returns:
      the sandbox

    • setSandBox

      void setSandBox(org.broadleafcommerce.common.sandbox.domain.SandBox sandBox)
      The sandbox to which this grouping belongs
      Parameters:
      sandBox - the sandbox

    • getItems

      List<WorkflowEventWorkflowItemXref> getItems()
      The WorkflowSandBoxItem contained in this grouping
      Returns:
      the individual change items from the user's sandbox

    • setItems

      void setItems(List<WorkflowEventWorkflowItemXref> items)
      The WorkflowSandBoxItem contained in this grouping
      Parameters:
      items - the individual change items from the user's sandbox

    • getHasError

      Boolean getHasError()
      Whether or not an error occurred during promotion of one or more of the contained WorkflowSandBoxItem instances.
      Returns:
      if there was a promotion problem

    • setHasError

      void setHasError(Boolean hasError)
      Whether or not an error occurred during promotion of one or more of the contained WorkflowSandBoxItem instances.
      Parameters:
      hasError - if there was a promotion problem

    • getScheduledDate

      Date getScheduledDate()
      The date/time for deployment to production if this item is part of a WorkflowDeployment
      Returns:
      target date for deployment to production

    • setScheduledDate

      void setScheduledDate(Date scheduledDate)
      The date/time for deployment to production if this item is part of a WorkflowDeployment
      Parameters:
      scheduledDate - target date for deployment to production

    • getDeployment

      WorkflowDeployment getDeployment()
      When this item is included in a scheduled deployment to production, this field will be populate
      Returns:
      scheduled deployment to production

    • setDeployment

      void setDeployment(WorkflowDeployment deployment)
      When this item is included in a scheduled deployment to production
      Parameters:
      deployment - scheduled deployment to production

    • removeDeployment

      void removeDeployment()
      Removes the Event's associated deployment

    • getNodeId

      String getNodeId()
      Return an tag that identifies the jobs and events cluster node on which this instance was created.
      Returns:
      See Also:
      • DatabaseSystemEventNode

    • setNodeId

      void setNodeId(String nodeId)

    • getIsComplete

      Boolean getIsComplete()
      Whether or not promotion replay for this instance is complete.
      Returns:

    • setIsComplete

      void setIsComplete(Boolean isComplete)

    • getIsStarted

      Boolean getIsStarted()
      Whether or not promotion replay for this instance has started.
      Returns:

    • setIsStarted

      void setIsStarted(Boolean isStarted)

    • getPromotionType

      PromotionType getPromotionType()
      The type of promotion being performed (i.e. PROMOTION and APPROVE)
      Returns:

    • setPromotionType

      void setPromotionType(PromotionType promotionType)

    • getPromotionDetails

      PromotionDetails getPromotionDetails()
      The thread state and other information necessary to replay this event in an asynchronous thread of execution.
      Returns:

    • setPromotionDetails

      void setPromotionDetails(PromotionDetails promotionDetails)

    • getSetupStatus

      int getSetupStatus()
      Represents the last completed setup state while starting the promotion or approval. This is useful when the system needs to reset data state after detecting a catastrophic failure during the initial setup of a promotion or approval.
      Returns:
      See Also:

    • setSetupStatus

      void setSetupStatus(int setupStatus)

    • getIsCritical

      Boolean getIsCritical()
      Whether or not the change set is considered critical.
      Returns:
      whether or not the change set is critical

    • setIsCritical

      void setIsCritical(Boolean isCritical)
      Whether or not the change set is considered critical.
      Parameters:
      isCritical - whether or not the change set is critical

    • getMarkedForPromotion

      List<WorkflowSandBoxItem> getMarkedForPromotion()
      Retrieve list of WorkflowSandBoxItem instances that were marked for user promotion as part of this event.
      Returns: