Serialized Form
-
Package com.broadleafcommerce.promotion.campaign.domain
-
Class com.broadleafcommerce.promotion.campaign.domain.Campaign extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
activeEndDate
Instant activeEndDate
Defines the ending time for which this campaign is active. -
activeStartDate
Instant activeStartDate
Defines the beginning time for which this campaign is active. -
codePrefix
String codePrefix
Defines a prefix to updateUses when generating campaign codes for this campaign. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
id
String id
The id of this campaign. This is also used as an identifier to track this campaign. -
name
String name
The user-readable name of this campaign
-
-
Class com.broadleafcommerce.promotion.campaign.domain.CampaignCode extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
activeEndDate
Instant activeEndDate
Defines the ending time for which this campaign code is active. Overrides the value set in theCampaign.activeEndDate
. -
activeStartDate
Instant activeStartDate
Defines the beginning time for which this campaign code is active. Overrides the value set in theCampaign.activeStartDate
. -
assigned
boolean assigned
Defines whether this code has been assigned for use. -
campaignId
String campaignId
Defines the id for the campaign that originated this campaign code. -
code
String code
The string code that represents this record. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
emailRegEx
String emailRegEx
Defines a regex to be used for validating this campaign code for customer updateUses. -
generatorId
String generatorId
Defines the id for the code generator that originated this campaign code. -
id
String id
-
maxUses
int maxUses
Defines the number of max uses allowed for this campaign code.
-
-
Class com.broadleafcommerce.promotion.campaign.domain.CampaignCodeAuditDetail extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
campaignCode
String campaignCode
The campaign code string that this audit information is for. -
campaignTrackingId
String campaignTrackingId
The tracking ID of the campaign this audit is for. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
dateApplied
Instant dateApplied
The date and time when the relatedcampaign code
was applied. -
id
String id
The context ID of the campaign code audit detail. -
user
UserTarget user
The identifying info of the user that used the campaign code.
-
-
Class com.broadleafcommerce.promotion.campaign.domain.CodeGenerationResult extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
errorMessage
String errorMessage
Error message from attempting to generateCampaignCodes
. -
generatedCodes
List<CampaignCode> generatedCodes
GeneratedCampaignCodes
. -
successful
boolean successful
Indicates whether the attempt to generateCampaignCodes
was successful.
-
-
Class com.broadleafcommerce.promotion.campaign.domain.CodeGenerator extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
activeEndDate
Instant activeEndDate
Sets the Active End Date for codes generated by this generator. -
activeStartDate
Instant activeStartDate
Sets the Active Start Date for codes generated by this generator. -
allowedLetters
String allowedLetters
Returns a String with the allowed letters to use when generating codes. If not set, code generation uses the character sets configured inCodeFormatAvailableCharHelper
-
allowedNumbers
String allowedNumbers
Returns a String with the allowed numbers to use when generating codes. If not set, code generation uses the character sets configured inCodeFormatAvailableCharHelper
-
campaignId
String campaignId
Defines the id for the campaign that originated this code generator. -
codeFormat
String codeFormat
The custom formatter for generating codes. Customer formatters allow for precise control of the code format. For example, consider "CF-##-@@-**-1" which might generate the following code "CF-99-AB-Z3-1". Each symbol is processed by the CodeGenerator. The default implementation is as follows: # is replaced by a random number (not including 0, 1, or 5) @ is replaced by a random character (not including 0, L, or S) * is replaced by random alphanumeric character (not including those mentioned above).- See Also:
DefaultCampaignCodeService
-
codeGenerationMessage
String codeGenerationMessage
Returns a String withCodeGenerator.getNumberOfCodesGenerated()
/CodeGenerator.getNumberOfCodesToGenerate()
If those values are equal, just returnsCodeGenerator.getNumberOfCodesGenerated()
Provides an easy way to determine progress. This field is automatically updated. -
codeGenerationStatus
String codeGenerationStatus
The current status -
codeLength
Integer codeLength
The code length the generator should use when generating the codes. -
codePrefix
String codePrefix
Defines a prefix to updateUses when generating campaign codes for this campaign. This will default toCampaign.getCodePrefix()
, if not set. This is intended to be used as an override, if required. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
createDate
Instant createDate
The date this generator was created. -
emailRegEx
String emailRegEx
Provides a customer email validation when the generated codes are requested for use. -
id
String id
-
maxUses
int maxUses
The maximum number of uses to set for each code generated. -
numberOfCodesGenerated
int numberOfCodesGenerated
The current number of codes that have been generated -
numberOfCodesToGenerate
int numberOfCodesToGenerate
The number of codes that will be generated -
updateDate
Instant updateDate
The date this generator was created. -
voucherCodeGenerator
boolean voucherCodeGenerator
Determines if thisCodeGenerator
is for voucher offers.
-
-
Class com.broadleafcommerce.promotion.campaign.domain.UserTarget extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
targetType
String targetType
The type of the user. This could be "CUSTOMER", "ACCOUNT", etc.- See Also:
DefaultUserTargetType
-
targetValue
String targetValue
An identifying value for the user. Could be an email, username, or some similarly identifying value.
-
-
Class com.broadleafcommerce.promotion.campaign.domain.VoucherCodeGenerationRequest extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
codeGenerator
CodeGenerator codeGenerator
TheCodeGenerator
to use to generate voucher codes. -
voucherCampaignId
String voucherCampaignId
TheCampaign.getId()
to generate the voucher codes from.
-
-
-
Package com.broadleafcommerce.promotion.campaign.provider.jpa.domain
-
Class com.broadleafcommerce.promotion.campaign.provider.jpa.domain.JpaCampaign extends Object implements Serializable
- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.promotion.campaign.provider.jpa.domain.JpaCampaignCode extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
activeEndDate
Instant activeEndDate
-
activeStartDate
Instant activeStartDate
-
assigned
boolean assigned
-
campaignId
String campaignId
-
code
String code
-
contextId
String contextId
-
emailRegEx
String emailRegEx
-
generatorId
String generatorId
-
maxUses
int maxUses
-
tracking
com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking
-
-
Class com.broadleafcommerce.promotion.campaign.provider.jpa.domain.JpaCampaignCodeAuditDetail extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
Class com.broadleafcommerce.promotion.campaign.provider.jpa.domain.JpaCodeGenerator extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
activeEndDate
Instant activeEndDate
-
activeStartDate
Instant activeStartDate
-
allowedLetters
String allowedLetters
-
allowedNumbers
String allowedNumbers
-
campaignId
String campaignId
-
codeFormat
String codeFormat
-
codeGenerationMessage
String codeGenerationMessage
-
codeGenerationStatus
String codeGenerationStatus
-
codeLength
Integer codeLength
-
codePrefix
String codePrefix
-
contextId
String contextId
-
createDate
Instant createDate
-
emailRegEx
String emailRegEx
-
maxUses
int maxUses
-
numberOfCodesGenerated
int numberOfCodesGenerated
-
numberOfCodesToGenerate
int numberOfCodesToGenerate
-
tracking
com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking
-
updateDate
Instant updateDate
-
voucherCodeGenerator
boolean voucherCodeGenerator
-
-