Serialized Form

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

Class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsabilityInfo

class CampaignCodeUsabilityInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

codeToUse

String codeToUse

A shared code for which this code usability tracks usage info.

codeUsabilityType

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.

See Also:

• CampaignCodeUsabilityType

codeUses

List<CampaignCodeUsage> codeUses

Infos on the uses of the related code used to determine if a campaign code can still be used.

Class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsage

class CampaignCodeUsage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

campaignTrackingId

String campaignTrackingId

The tracking id of the campaign for which this code usability info belongs.

canUse

boolean canUse

If this code can be used for the campaign based on it's max uses.

hasMaxUsage

boolean hasMaxUsage

Whether this code has a maximum limit to the number of times it can be used as defined by it's max uses.

usesLeft

int usesLeft

The number of uses left for this info's related campaign code. This is calculated by subtracting the number of times the code has been used from it's max uses.

Class com.broadleafcommerce.promotion.campaign.client.web.context.CampaignCodeUsageValidationResult

class CampaignCodeUsageValidationResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

invalidCampaignCodes

List<String> invalidCampaignCodes

The list of campaign codes which are no longer usable.

isUsageValid

boolean isUsageValid

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. Default is true.

validationFailureMessages

Map<String,String> validationFailureMessages

Mapping of campaign codes to failure messages. Each campaign code usage that failed validation should have an entry in this map with a specific failure message.