Package com.broadleafcommerce.promotion.offer.domain

Class Campaign

java.lang.Object
com.broadleafcommerce.promotion.offer.domain.Campaign
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, ActiveDateEntity, Serializable
public class Campaign extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware, ActiveDateEntity
The main domain that the Broadleaf Campaign service is based around. Campaigns are the base to which you can generate multiple codes against.
Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • Campaign

      public Campaign()

  • Method Details

    • getId

      public String getId()
      The id of this campaign. This is also used as an identifier to track this campaign.

    • getExternalId

      public String getExternalId()
      This is an arbitrary ID, typically assigned by or used by 1st or 3rd party systems that are not Broadleaf.
      Returns:
      an external ID

    • getName

      public String getName()
      The user-readable name of this campaign

    • getCodePrefix

      public String getCodePrefix()
      Defines a prefix to updateUses when generating campaign codes for this campaign.

    • getActiveStartDate

      public Instant getActiveStartDate()
      Defines the beginning time for which this campaign is active.
      Specified by:
      getActiveStartDate in interface ActiveDateEntity
      Returns:
      The time at which this entity becomes active for storefront consumption

    • getActiveEndDate

      public Instant getActiveEndDate()
      Defines the ending time for which this campaign is active.
      Specified by:
      getActiveEndDate in interface ActiveDateEntity
      Returns:
      The time at which this entity becomes inactive for storefront consumption

    • 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 id of this campaign. This is also used as an identifier to track this campaign.

    • setExternalId

      public void setExternalId(String externalId)
      This is an arbitrary ID, typically assigned by or used by 1st or 3rd party systems that are not Broadleaf.
      Parameters:
      externalId - an external ID, often a DB or business ID, from a system outside of Broadleaf

    • setName

      public void setName(String name)
      The user-readable name of this campaign

    • setCodePrefix

      public void setCodePrefix(String codePrefix)
      Defines a prefix to updateUses when generating campaign codes for this campaign.

    • setActiveStartDate

      public void setActiveStartDate(Instant activeStartDate)
      Defines the beginning time for which this campaign is active.

    • setActiveEndDate

      public void setActiveEndDate(Instant activeEndDate)
      Defines the ending time for which this campaign is active.

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class 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