Package com.broadleafcommerce.promotion.campaign.domain

Class Campaign

  • All Implemented Interfaces:
    com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
    public class Campaign
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
    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:
    Serialized Form

    • Constructor Detail

      • Campaign

        public Campaign()

    • Method Detail

      • getId

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

      • 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.

      • getActiveEndDate

        public Instant getActiveEndDate()
        Defines the ending time for which this campaign is active.

      • 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.

      • 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

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object