Package com.broadleafcommerce.orderoperation.domain

Class CampaignCode

  • All Implemented Interfaces:
    Serializable
    public class CampaignCode
extends Object
implements Serializable
    A CampaignCode represents a distinct code for a Campaign. It is typically created through the Code Generation endpoint and services.
    Author:
    Chad Harchar (charchar)
    See Also:
    Serialized Form

    • Constructor Detail

      • CampaignCode

        public CampaignCode()

    • Method Detail

      • getId

        public String getId()

      • getCode

        public String getCode()
        The string code that represents this record.

      • getActiveStartDate

        public Instant getActiveStartDate()
        Defines the beginning time for which this campaign code is active. Overrides the value set in the Campaign#activeStartDate.

      • getActiveEndDate

        public Instant getActiveEndDate()
        Defines the ending time for which this campaign code is active. Overrides the value set in the Campaign#activeEndDate.

      • getMaxUses

        public int getMaxUses()
        Defines the number of max uses allowed for this campaign code.

      • getEmailRegEx

        public String getEmailRegEx()
        Defines a regex to be used for validating this campaign code for customer updateUses.

      • getCampaignId

        public String getCampaignId()
        Defines the id for the campaign that originated this campaign code.

      • getGeneratorId

        public String getGeneratorId()
        Defines the id for the code generator that originated this campaign code.

      • isAssigned

        public boolean isAssigned()
        Defines whether this code has been assigned for use.

      • setId

        public void setId​(String id)

      • setCode

        public void setCode​(String code)
        The string code that represents this record.

      • setActiveStartDate

        public void setActiveStartDate​(Instant activeStartDate)
        Defines the beginning time for which this campaign code is active. Overrides the value set in the Campaign#activeStartDate.

      • setActiveEndDate

        public void setActiveEndDate​(Instant activeEndDate)
        Defines the ending time for which this campaign code is active. Overrides the value set in the Campaign#activeEndDate.

      • setMaxUses

        public void setMaxUses​(int maxUses)
        Defines the number of max uses allowed for this campaign code.

      • setEmailRegEx

        public void setEmailRegEx​(String emailRegEx)
        Defines a regex to be used for validating this campaign code for customer updateUses.

      • setCampaignId

        public void setCampaignId​(String campaignId)
        Defines the id for the campaign that originated this campaign code.

      • setGeneratorId

        public void setGeneratorId​(String generatorId)
        Defines the id for the code generator that originated this campaign code.

      • setAssigned

        public void setAssigned​(boolean assigned)
        Defines whether this code has been assigned for use.

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object