Package com.broadleafcommerce.sandbox.domain

Class Sandbox

java.lang.Object
com.broadleafcommerce.sandbox.domain.Sandbox
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
public class Sandbox extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
TODO what __is__ a sandbox Business domain representing a configured sandbox. Sandboxable entities (see TrackableExtension) declare a reference to this Sandbox in Tracking.getSandbox(). Entities created in a sandbox are driven by ContextRequest.getSandboxId(), which is generally set by the admin application. Any Tracking.getSandbox() should map to one of these sandboxes.
Author:
Jeff Fischer
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Sandbox()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    String
    getApplication()
    The ID of the owning application.
    String
    getColor()
    The color used to mark the sandbox in the admin user interface.
    com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState
    getContextState()
    A subset of Tracking information to expose the context state for this object.
    String
    getDescription()
    A short description of the purpose of the sandbox.
    String
    getId()
    The context id, which is a separate identifier from the database primary key.
    String
    getName()
    Name of this sandbox such as "Jon's sandbox" or "CMS Team 1's sandbox".
    String
    getTenant()
    The ID of the owning tenant.
    int
    hashCode()
     
    boolean
    isTemporarySandbox()
    Whether or not the sandbox should be automatically removed by the system when all associated ChangeSummary instances are reverted or deployed.
    void
    setApplication(String application)
    The ID of the owning application.
    void
    setColor(String color)
    The color used to mark the sandbox in the admin user interface.
    void
    setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
    A subset of Tracking information to expose the context state for this object.
    void
    setDescription(String description)
    A short description of the purpose of the sandbox.
    void
    setId(String id)
    The context id, which is a separate identifier from the database primary key.
    void
    setName(String name)
    Name of this sandbox such as "Jon's sandbox" or "CMS Team 1's sandbox".
    void
    setTemporarySandbox(boolean isTemporarySandbox)
    Whether or not the sandbox should be automatically removed by the system when all associated ChangeSummary instances are reverted or deployed.
    void
    setTenant(String tenant)
    The ID of the owning tenant.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Sandbox

      public Sandbox()

  • Method Details

    • getId

      public String getId()
      The context id, which is a separate identifier from the database primary key. This may be auto generated, or may be explicitly provided upon entity creation.
      Returns:
      Separate identifier from the database primary key

    • getName

      public String getName()
      Name of this sandbox such as "Jon's sandbox" or "CMS Team 1's sandbox".
      Returns:
      the name of this sandbox

    • getColor

      public String getColor()
      The color used to mark the sandbox in the admin user interface. Should be a hexidecimal representation. For example, #FFFFFF.
      Returns:
      The color used to mark the sandbox in the admin user interface

    • getDescription

      public String getDescription()
      A short description of the purpose of the sandbox.
      Returns:
      A short description of the purpose of the sandbox.

    • getApplication

      public String getApplication()
      The ID of the owning application.
      Returns:
      The ID of the owning application

    • getTenant

      public String getTenant()
      The ID of the owning tenant.
      Returns:
      The ID of the owning tenant

    • isTemporarySandbox

      public boolean isTemporarySandbox()
      Whether or not the sandbox should be automatically removed by the system when all associated ChangeSummary instances are reverted or deployed.
      Returns:
      Whether or not the sandbox should be automatically removed

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • setId

      public void setId(String id)
      The context id, which is a separate identifier from the database primary key. This may be auto generated, or may be explicitly provided upon entity creation.
      Parameters:
      id - Separate identifier from the database primary key

    • setName

      public void setName(String name)
      Name of this sandbox such as "Jon's sandbox" or "CMS Team 1's sandbox".
      Parameters:
      name - Name of this sandbox

    • setColor

      public void setColor(String color)
      The color used to mark the sandbox in the admin user interface. Should be a hexidecimal representation. For example, #FFFFFF.
      Parameters:
      color - The color used to mark the sandbox in the admin user interface

    • setDescription

      public void setDescription(String description)
      A short description of the purpose of the sandbox.
      Parameters:
      description - A short description of the purpose of the sandbox.

    • setApplication

      public void setApplication(String application)
      The ID of the owning application.
      Parameters:
      application - The ID of the owning application

    • setTenant

      public void setTenant(String tenant)
      The ID of the owning tenant.
      Parameters:
      tenant - The ID of the owning tenant

    • setTemporarySandbox

      public void setTemporarySandbox(boolean isTemporarySandbox)
      Whether or not the sandbox should be automatically removed by the system when all associated ChangeSummary instances are reverted or deployed.
      Parameters:
      isTemporarySandbox - Whether or not the sandbox should be automatically removed

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • 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