Package com.broadleafcommerce.promotion.campaign.client.web.context

Class CampaignCodeUsabilityInfo

java.lang.Object
com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo
All Implemented Interfaces:
Serializable
public class CampaignCodeUsabilityInfo extends Object implements Serializable
Contains information on a code's usability. That is, whether the code can be used or not and detailed information on the corresponding campaign.
Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • CampaignCodeUsabilityInfo

      public CampaignCodeUsabilityInfo()

  • Method Details

    • isCodeUsable

      public boolean isCodeUsable()
      Whether the related campaign code's has uses left.
      Returns:
      Whether the related campaign code's has uses left.

    • getCodeToUse

      public String getCodeToUse()
      A shared code for which this code usability tracks usage info.
      Returns:
      A shared code for which this code usability tracks usage info.

    • getCodeUsabilityType

      public String getCodeUsabilityType()
      Describes the usability of the code. This is mainly used to differentiate the different reasons a code might not be usable: It matches no campaign codes, it's been used the maximum number times, etc.
      Returns:
      The usability of the code
      See Also:

    • getCodeUses

      public List<CampaignCodeUsage> getCodeUses()
      Infos on the uses of the related code used to determine if a campaign code can still be used.
      Returns:
      Infos on the uses of the related code used to determine if a campaign code can still be used.

    • setCodeToUse

      public void setCodeToUse(String codeToUse)
      A shared code for which this code usability tracks usage info.
      Parameters:
      codeToUse - A shared code for which this code usability tracks usage info.

    • setCodeUsabilityType

      public void setCodeUsabilityType(String codeUsabilityType)
      Describes the usability of the code. This is mainly used to differentiate the different reasons a code might not be usable: It matches no campaign codes, it's been used the maximum number times, etc.
      Parameters:
      codeUsabilityType - The usability of the code
      See Also:

    • setCodeUses

      public void setCodeUses(List<CampaignCodeUsage> codeUses)
      Infos on the uses of the related code used to determine if a campaign code can still be used.
      Parameters:
      codeUses - Infos on the uses of the related code used to determine if a campaign code can still be used.

    • 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