Index (Broadleaf Promotion Services Campaign Client 2.0.1-GA API)

C E G H I M N S T U V
All Classes and Interfaces|All Packages|Serialized Form

C

CampaignCodeUsabilityInfo - Class in com.broadleafcommerce.promotion.campaign.client.web.context: Contains information on a code's usability.
CampaignCodeUsabilityInfo() - Constructor for class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo
CampaignCodeUsabilityType - Enum Class in com.broadleafcommerce.promotion.campaign.client.web.context: Enumerates the different values possible for CampaignCodeUsabilityInfo.getCodeUsabilityType().
CampaignCodeUsage - Class in com.broadleafcommerce.promotion.campaign.client.web.context: Information on a CampaignCodeUsabilityInfo.getCodeToUse() usage for a related campaign.
CampaignCodeUsage() - Constructor for class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage
CampaignCodeUsage(String, boolean, boolean, int) - Constructor for class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage
CampaignCodeUsageValidationResult - Class in com.broadleafcommerce.promotion.campaign.client.web.context: DTO holding the resulting information about the validity of campaign codes.
CampaignCodeUsageValidationResult() - Constructor for class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult
canEqual(Object) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo
canEqual(Object) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage
canEqual(Object) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult
com.broadleafcommerce.promotion.campaign.client.web.context - package com.broadleafcommerce.promotion.campaign.client.web.context

E

equals(Object) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo
equals(Object) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage
equals(Object) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult

G

getCampaignTrackingId() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: The tracking id of the campaign for which this code usability info belongs.
getCodeToUse() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo: A shared code for which this code usability tracks usage info.
getCodeUsabilityType() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo: Describes the usability of the code.
getCodeUses() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo: Infos on the uses of the related code used to determine if a campaign code can still be used.
getInvalidCampaignCodes() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult: The list of campaign codes which are no longer usable.
getUsesLeft() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: The number of uses left for this info's related campaign code.
getValidationFailureMessages() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult: Mapping of campaign codes to failure messages.

H

hashCode() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo
hashCode() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage
hashCode() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult

I

isCanUse() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: If this code can be used for the campaign based on it's max uses.
isCodeUsable() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo: Whether the related campaign code's has uses left.
isHasMaxUsage() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: Whether this code has a maximum limit to the number of times it can be used as defined by it's max uses.
isUsageValid() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult: If this is set to false, one or more campaign codes is no longer valid and need to be removed from the list of previously applied campaigns.

M

MAX_USES - Enum constant in enum class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityType: Means that the code cannot be used because it has been used the maximum number of times already.

N

NO_CAMPAIGNS_MATCH - Enum constant in enum class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityType: Means that the code cannot be used because it matches no campaigns.

S

setCampaignTrackingId(String) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: The tracking id of the campaign for which this code usability info belongs.
setCanUse(boolean) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: If this code can be used for the campaign based on it's max uses.
setCodeToUse(String) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo: A shared code for which this code usability tracks usage info.
setCodeUsabilityType(String) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo: Describes the usability of the code.
setCodeUses(List<CampaignCodeUsage>) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo: Infos on the uses of the related code used to determine if a campaign code can still be used.
setHasMaxUsage(boolean) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: Whether this code has a maximum limit to the number of times it can be used as defined by it's max uses.
setInvalidCampaignCodes(List<String>) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult: The list of campaign codes which are no longer usable.
setUsageValid(boolean) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult: If this is set to false, one or more campaign codes is no longer valid and need to be removed from the list of previously applied campaigns.
setUsesLeft(int) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage: The number of uses left for this info's related campaign code.
setValidationFailureMessages(Map<String, String>) - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult: Mapping of campaign codes to failure messages.

T

toString() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo
toString() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage
toString() - Method in class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult

U

USABLE - Enum constant in enum class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityType: The only value which means that the code can be used.

V

valueOf(String) - Static method in enum class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityType: Returns an array containing the constants of this enum class, in the order they are declared.

C E G H I M N S T U V
All Classes and Interfaces|All Packages|Serialized Form