com.broadleafcommerce.advancedoffer.codes.domain

Class OfferCodeGenerationInfoImpl

java.lang.Object

com.broadleafcommerce.advancedoffer.codes.domain.OfferCodeGenerationInfoImpl

All Implemented Interfaces:

OfferCodeGenerationInfo, OfferCodeGenerationInfoAdminPresentation, Serializable, org.broadleafcommerce.common.admin.domain.AdminMainEntity, org.broadleafcommerce.common.copy.MultiTenantCloneable<OfferCodeGenerationInfo>

@Entity
public class OfferCodeGenerationInfoImpl
extends Object
implements OfferCodeGenerationInfo, org.broadleafcommerce.common.admin.domain.AdminMainEntity, OfferCodeGenerationInfoAdminPresentation

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.advancedoffer.codes.domain.OfferCodeGenerationInfoAdminPresentation

OfferCodeGenerationInfoAdminPresentation.GroupName, OfferCodeGenerationInfoAdminPresentation.GroupOrder, OfferCodeGenerationInfoAdminPresentation.TabName, OfferCodeGenerationInfoAdminPresentation.TabOrder

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	activeStartDate
protected List<OfferCodeGenerationAdditionalOfferXref>	additionalOffers
protected Date	createDate
protected String	emailRegEx
protected Date	endDate
protected List<org.broadleafcommerce.core.offer.domain.OfferCode>	offerCodes
protected Date	updateDate

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
OfferCodeGenerationInfoImpl()

Method Summary

Modifier and Type	Method and Description
<G extends OfferCodeGenerationInfo> org.broadleafcommerce.common.copy.CreateResponse<G>	createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext context)
boolean	equals(Object o)
Date	getActiveStartDate() Returns the Active Start Date for a code group that is used if an offer code does not have an Active Date
List<OfferCodeGenerationAdditionalOfferXref>	getAdditionalOffers() Returns the additional offers that are associated to this generator.
String	getCodeFormat() Returns the custom formatter for generating codes.
CodeGenerationMethodType	getCodeGenerationMethod() Returns the CodeGenerationType being used to generate offer codes.
String	getCodeGenerationProgressMessage() Returns a String with OfferCodeGenerationInfo.getNumberOfCodesGenerated() / #getNumberOfCodesRequested() If those values = just returns OfferCodeGenerationInfo.getNumberOfCodesGenerated() Gives the admin an easy way to return progress.
CodeGenerationStatusType	getCodeGenerationStatus() Returns the CodeGenerationType being used to generate offer codes.
Integer	getCodeLength() Returns the length of the code the generator should generated (not including the length of the prefix).
String	getCodePrefix() Returns the code prefix the generator should use to prepend to any generated offer code.
Date	getCreateDate() Return date this generator was created.
String	getDescription() Returns the description
String	getEmailRegEx() Returns the EmailRegEx used to validate an offerCode
Date	getEndDate() Returns the End Date for a code group that is used if an offer code does not have an End Date
Long	getId() Returns the unique id
boolean	getIgnoreGuessabilityError() If set, allows codes to be generated that might be easily guessed.
String	getMainEntityName()
Integer	getMaxUses() Returns the maximum number of uses to set for each code generated.
int	getNumberOfCodesGenerated() Returns the number of codes actually generated by this code generator.
Integer	getNumberOfCodesToGenerate() Number of codes that should be generated.
org.broadleafcommerce.core.offer.domain.Offer	getOffer() Returns the associated offer for which codes are being generated.
List<org.broadleafcommerce.core.offer.domain.OfferCode>	getOfferCodes() Returns the offer codes that were created as part of this generator.
Date	getUpdateDate() Return date this generator was last updated.
int	hashCode()
void	setActiveStartDate(Date activeStartDate) Set the Active Start Date for a code group that is used if an offer code does not have an Active Date
void	setAdditionalOffers(List<OfferCodeGenerationAdditionalOfferXref> additionalOffers) Sets additional offers that are associated to this generator.
void	setCodeFormat(String codeFormat) Sets a custom formatter for generating codes.
void	setCodeGenerationMethod(CodeGenerationMethodType codeGenerationMethod) Sets the CodeGenerationType being used to generate offer codes.
void	setCodeGenerationProgressMessage(String codeGenerationMessage)
void	setCodeGenerationStatus(CodeGenerationStatusType codeGenerationStatus) Sets the CodeGenerationStatusType being used to generate offer codes.
void	setCodeLength(Integer codeLength) Sets the code length the generator should use when generating the codes.
void	setCodePrefix(String codePrefix) Sets the codePrefix
void	setCreateDate(Date createDate) Set the date this generator was created.
void	setDescription(String description) Sets the description
void	setEmailRegEx(String emailRegEx) Sets EmailRegEx that is used to validate offerCodes
void	setEndDate(Date endDate) Set the End Date for a code group that is used if an offer code does not have an End Date
void	setId(Long id) Sets the id
void	setIgnoreGuessabilityError(boolean ignoreGuessabilityError) Sets the system to ignore guessability warning.
void	setMaxUses(Integer maxUses) Sets the maximum number of orders that the code can be used in.
void	setNumberOfCodesGenerated(Integer numberOfCodesGenerated) Sets the number of codes to generate.
void	setNumberOfCodesToGenerate(Integer numberOfCodesToGenerate) The maximum amount of OfferCodes that can be generated is set by the system property offerCode.maxCodeGeneration.
void	setOffer(org.broadleafcommerce.core.offer.domain.Offer offer) Sets the associated offer for which codes are being generated.
void	setOfferCodes(List<org.broadleafcommerce.core.offer.domain.OfferCode> offerCodes) Sets the offer codes that can be used to retrieve this Offer.
void	setUpdateDate(Date updateDate) Set the date this generator was last updated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

additionalOffers

protected List<OfferCodeGenerationAdditionalOfferXref> additionalOffers

createDate

protected Date createDate

updateDate

protected Date updateDate

offerCodes

protected List<org.broadleafcommerce.core.offer.domain.OfferCode> offerCodes

emailRegEx

protected String emailRegEx

activeStartDate

protected Date activeStartDate

endDate

protected Date endDate

Constructor Detail

OfferCodeGenerationInfoImpl

public OfferCodeGenerationInfoImpl()

Method Detail

getId

public Long getId()

Description copied from interface: OfferCodeGenerationInfo

Returns the unique id

Specified by:

getId in interface OfferCodeGenerationInfo

Returns:

setId

public void setId(Long id)

Description copied from interface: OfferCodeGenerationInfo

Sets the id

Specified by:

setId in interface OfferCodeGenerationInfo

getDescription

public String getDescription()

Description copied from interface: OfferCodeGenerationInfo

Returns the description

Specified by:

getDescription in interface OfferCodeGenerationInfo

Returns:

setDescription

public void setDescription(String description)

Description copied from interface: OfferCodeGenerationInfo

Sets the description

Specified by:

setDescription in interface OfferCodeGenerationInfo

getNumberOfCodesToGenerate

public Integer getNumberOfCodesToGenerate()

Description copied from interface: OfferCodeGenerationInfo

Number of codes that should be generated. Required.

Specified by:

getNumberOfCodesToGenerate in interface OfferCodeGenerationInfo

Returns:

setNumberOfCodesToGenerate

public void setNumberOfCodesToGenerate(Integer numberOfCodesToGenerate)

The maximum amount of OfferCodes that can be generated is set by the system property offerCode.maxCodeGeneration. The default value for maximum code generation is 100,000

Specified by:

setNumberOfCodesToGenerate in interface OfferCodeGenerationInfo

Parameters:

numberOfCodesToGenerate -

getNumberOfCodesGenerated

public int getNumberOfCodesGenerated()

Description copied from interface: OfferCodeGenerationInfo

Returns the number of codes actually generated by this code generator.

Specified by:

getNumberOfCodesGenerated in interface OfferCodeGenerationInfo

Returns:

setNumberOfCodesGenerated

public void setNumberOfCodesGenerated(Integer numberOfCodesGenerated)

Description copied from interface: OfferCodeGenerationInfo

Sets the number of codes to generate.

Specified by:

setNumberOfCodesGenerated in interface OfferCodeGenerationInfo

getOffer

public org.broadleafcommerce.core.offer.domain.Offer getOffer()

Description copied from interface: OfferCodeGenerationInfo

Returns the associated offer for which codes are being generated.

Specified by:

getOffer in interface OfferCodeGenerationInfo

Returns:

setOffer

public void setOffer(org.broadleafcommerce.core.offer.domain.Offer offer)

Description copied from interface: OfferCodeGenerationInfo

Sets the associated offer for which codes are being generated.

Specified by:

setOffer in interface OfferCodeGenerationInfo

getCodeFormat

public String getCodeFormat()

Description copied from interface: OfferCodeGenerationInfo

Returns the custom formatter for generating codes. Customer formatters allow for precise control of the code format. This setting is used only for CodeGenerationMethodType.SPECIFY_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)

Specified by:

getCodeFormat in interface OfferCodeGenerationInfo

Returns:

See Also:

CodeGeneratorServiceImpl

setCodeFormat

public void setCodeFormat(String codeFormat)

Description copied from interface: OfferCodeGenerationInfo

Sets a custom formatter for generating codes.

Specified by:

setCodeFormat in interface OfferCodeGenerationInfo

See Also:

OfferCodeGenerationInfo.getCodeFormat()

getCodePrefix

public String getCodePrefix()

Description copied from interface: OfferCodeGenerationInfo

Returns the code prefix the generator should use to prepend to any generated offer code. All codes will be prepended with this prefix. This setting is ignored for CodeGenerationMethodType.SPECIFY_FORMAT.

Specified by:

getCodePrefix in interface OfferCodeGenerationInfo

Returns:

setCodePrefix

public void setCodePrefix(String codePrefix)

Description copied from interface: OfferCodeGenerationInfo

Sets the codePrefix

Specified by:

setCodePrefix in interface OfferCodeGenerationInfo

See Also:

OfferCodeGenerationInfo.getCodePrefix()

getCodeLength

public Integer getCodeLength()

Description copied from interface: OfferCodeGenerationInfo

Returns the length of the code the generator should generated (not including the length of the prefix). This setting is used only for CodeGenerationMethodType.SPECIFY_LENGTH.

Specified by:

getCodeLength in interface OfferCodeGenerationInfo

Returns:

setCodeLength

public void setCodeLength(Integer codeLength)

Description copied from interface: OfferCodeGenerationInfo

Sets the code length the generator should use when generating the codes.

Specified by:

setCodeLength in interface OfferCodeGenerationInfo

See Also:

OfferCodeGenerationInfo.getCodeLength()

getMaxUses

public Integer getMaxUses()

Description copied from interface: OfferCodeGenerationInfo

Returns the maximum number of uses to set for each code generated.

Specified by:

getMaxUses in interface OfferCodeGenerationInfo

Returns:

setMaxUses

public void setMaxUses(Integer maxUses)

Description copied from interface: OfferCodeGenerationInfo

Sets the maximum number of orders that the code can be used in. Use in conjunction with Offer.getMaxUsesPerOrder() to limit the number of times the offer can be used within the same order.

Specified by:

setMaxUses in interface OfferCodeGenerationInfo

See Also:

OfferCodeGenerationInfo.getMaxUses()

getCodeGenerationStatus

public CodeGenerationStatusType getCodeGenerationStatus()

Description copied from interface: OfferCodeGenerationInfo

Returns the CodeGenerationType being used to generate offer codes.

Specified by:

getCodeGenerationStatus in interface OfferCodeGenerationInfo

setCodeGenerationStatus

public void setCodeGenerationStatus(CodeGenerationStatusType codeGenerationStatus)

Description copied from interface: OfferCodeGenerationInfo

Sets the CodeGenerationStatusType being used to generate offer codes.

Specified by:

setCodeGenerationStatus in interface OfferCodeGenerationInfo

getCodeGenerationMethod

public CodeGenerationMethodType getCodeGenerationMethod()

Description copied from interface: OfferCodeGenerationInfo

Returns the CodeGenerationType being used to generate offer codes.

Specified by:

getCodeGenerationMethod in interface OfferCodeGenerationInfo

setCodeGenerationMethod

public void setCodeGenerationMethod(CodeGenerationMethodType codeGenerationMethod)

Description copied from interface: OfferCodeGenerationInfo

Sets the CodeGenerationType being used to generate offer codes.

Specified by:

setCodeGenerationMethod in interface OfferCodeGenerationInfo

getIgnoreGuessabilityError

public boolean getIgnoreGuessabilityError()

Description copied from interface: OfferCodeGenerationInfo

If set, allows codes to be generated that might be easily guessed. System code generation is likely to fail for this mode when using random code generation as it will produce an excessive amount of collisions and fail.

Specified by:

getIgnoreGuessabilityError in interface OfferCodeGenerationInfo

Returns:

setIgnoreGuessabilityError

public void setIgnoreGuessabilityError(boolean ignoreGuessabilityError)

Description copied from interface: OfferCodeGenerationInfo

Sets the system to ignore guessability warning.

Specified by:

setIgnoreGuessabilityError in interface OfferCodeGenerationInfo

getCreateDate

public Date getCreateDate()

Description copied from interface: OfferCodeGenerationInfo

Return date this generator was created.

Specified by:

getCreateDate in interface OfferCodeGenerationInfo

Returns:

setCreateDate

public void setCreateDate(Date createDate)

Description copied from interface: OfferCodeGenerationInfo

Set the date this generator was created.

Specified by:

setCreateDate in interface OfferCodeGenerationInfo

getUpdateDate

public Date getUpdateDate()

Description copied from interface: OfferCodeGenerationInfo

Return date this generator was last updated.

Specified by:

getUpdateDate in interface OfferCodeGenerationInfo

Returns:

setUpdateDate

public void setUpdateDate(Date updateDate)

Description copied from interface: OfferCodeGenerationInfo

Set the date this generator was last updated.

Specified by:

setUpdateDate in interface OfferCodeGenerationInfo

getCodeGenerationProgressMessage

public String getCodeGenerationProgressMessage()

Description copied from interface: OfferCodeGenerationInfo

Returns a String with OfferCodeGenerationInfo.getNumberOfCodesGenerated() / #getNumberOfCodesRequested() If those values = just returns OfferCodeGenerationInfo.getNumberOfCodesGenerated() Gives the admin an easy way to return progress. This field is automatically updated when setCod

Specified by:

getCodeGenerationProgressMessage in interface OfferCodeGenerationInfo

Returns:

setCodeGenerationProgressMessage

public void setCodeGenerationProgressMessage(String codeGenerationMessage)

Specified by:

setCodeGenerationProgressMessage in interface OfferCodeGenerationInfo

See Also:

OfferCodeGenerationInfo.getCodeGenerationProgressMessage()

getOfferCodes

public List<org.broadleafcommerce.core.offer.domain.OfferCode> getOfferCodes()

Description copied from interface: OfferCodeGenerationInfo

Returns the offer codes that were created as part of this generator.

Specified by:

getOfferCodes in interface OfferCodeGenerationInfo

Returns:

setOfferCodes

public void setOfferCodes(List<org.broadleafcommerce.core.offer.domain.OfferCode> offerCodes)

Description copied from interface: OfferCodeGenerationInfo

Sets the offer codes that can be used to retrieve this Offer. These codes would be used in situations where this Offer is not automatically considered

Specified by:

setOfferCodes in interface OfferCodeGenerationInfo

getAdditionalOffers

public List<OfferCodeGenerationAdditionalOfferXref> getAdditionalOffers()

Description copied from interface: OfferCodeGenerationInfo

Returns the additional offers that are associated to this generator.

Specified by:

getAdditionalOffers in interface OfferCodeGenerationInfo

Returns:

setAdditionalOffers

public void setAdditionalOffers(List<OfferCodeGenerationAdditionalOfferXref> additionalOffers)

Description copied from interface: OfferCodeGenerationInfo

Sets additional offers that are associated to this generator. These offers will also be applied to an order whenever one of the associated codes is used.

Specified by:

setAdditionalOffers in interface OfferCodeGenerationInfo

getEmailRegEx

public String getEmailRegEx()

Description copied from interface: OfferCodeGenerationInfo

Returns the EmailRegEx used to validate an offerCode

Specified by:

getEmailRegEx in interface OfferCodeGenerationInfo

Returns:

setEmailRegEx

public void setEmailRegEx(String emailRegEx)

Description copied from interface: OfferCodeGenerationInfo

Sets EmailRegEx that is used to validate offerCodes

Specified by:

setEmailRegEx in interface OfferCodeGenerationInfo

getActiveStartDate

public Date getActiveStartDate()

Description copied from interface: OfferCodeGenerationInfo

Returns the Active Start Date for a code group that is used if an offer code does not have an Active Date

Specified by:

getActiveStartDate in interface OfferCodeGenerationInfo

setActiveStartDate

public void setActiveStartDate(Date activeStartDate)

Description copied from interface: OfferCodeGenerationInfo

Set the Active Start Date for a code group that is used if an offer code does not have an Active Date

Specified by:

setActiveStartDate in interface OfferCodeGenerationInfo

getEndDate

public Date getEndDate()

Description copied from interface: OfferCodeGenerationInfo

Returns the End Date for a code group that is used if an offer code does not have an End Date

Specified by:

getEndDate in interface OfferCodeGenerationInfo

setEndDate

public void setEndDate(Date endDate)

Description copied from interface: OfferCodeGenerationInfo

Set the End Date for a code group that is used if an offer code does not have an End Date

Specified by:

setEndDate in interface OfferCodeGenerationInfo

createOrRetrieveCopyInstance

public <G extends OfferCodeGenerationInfo> org.broadleafcommerce.common.copy.CreateResponse<G> createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext context)
                                                                                                                     throws CloneNotSupportedException

Specified by:

createOrRetrieveCopyInstance in interface org.broadleafcommerce.common.copy.MultiTenantCloneable<OfferCodeGenerationInfo>

Throws:

CloneNotSupportedException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface org.broadleafcommerce.common.admin.domain.AdminMainEntity