Package com.broadleafcommerce.catalog.domain.product.commerce

Class ItemChoiceDetail

java.lang.Object

com.broadleafcommerce.catalog.domain.product.commerce.ItemChoiceDetail

All Implemented Interfaces:

Serializable

public class ItemChoiceDetail
extends Object
implements Serializable

A version of ItemChoice tailored toward the needs of a commerce-facing product details page.

Author:

Nathan Moore (nathandmoore)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ItemChoiceDetail()
ItemChoiceDetail(ItemChoice itemChoice, ItemChoiceCategory category, ProductDetails defaultProductInCategory, ProductDetails defaultProduct, VariantDetail defaultVariant, PriceInfo priceInfo, List<SpecificItemChoiceDetail> specificChoices, SpecificItemChoiceDetail specificItemChoice)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
<T> T	getAttribute(String name)
Map<String,Object>	getAttributes()
ItemChoiceCategory	getCategory()	The ItemChoiceCategory which the choice will be chosen from by the customer if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY.
String	getChoiceKey()
javax.money.MonetaryAmount	getDefaultChoiceOverridePrice()
javax.money.MonetaryAmount	getDefaultChoicePrice()
String	getDefaultChoicePricingKey()
ProductTerm	getDefaultChoiceUnderlyingDefaultTerm()
String	getDefaultChoiceUnderlyingPricingKey()
String	getDefaultChoiceUnderlyingSku()
javax.money.MonetaryAmount	getDefaultPrice()
ProductDetails	getDefaultProduct()	The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS.
ProductDetails	getDefaultProductInCategory()	The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY.
VariantDetail	getDefaultVariant()	The default variant that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS.
ItemChoice	getItemChoice()
Integer	getMaximumQuantity()
Integer	getMinimumQuantity()
javax.money.MonetaryAmount	getOverridePrice()
PriceInfo	getPriceInfo()	Summary of the pricing information related to the choice.
String	getPricingKey()
Integer	getRestrictQtyDecreaseAfterDays()
Integer	getRestrictRemovalAfterDays()
String	getSelectionType()
List<SpecificItemChoiceDetail>	getSpecificChoices()	If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from.
SpecificItemChoiceDetail	getSpecificItemChoice()	If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on.
String	getTargetType()
int	hashCode()
boolean	isAllowAddAfterInitialPurchase()
boolean	isAllowEditAfterInitialPurchase()
boolean	isAllowQtyEditAfterInitialPurchase()
boolean	isAllowRemoveAfterInitialPurchase()
boolean	isDiscountAllowed()
boolean	isHasPostPurchaseEditRules()
boolean	isPriceOverridden()
boolean	isSeparateFromPrimaryItem()
boolean	isSubscription()
void	setAllowAddAfterInitialPurchase(boolean allowAddAfterInitialPurchase)
void	setAllowEditAfterInitialPurchase(boolean allowEditAfterInitialPurchase)
void	setAllowQtyEditAfterInitialPurchase(boolean allowQtyEditAfterInitialPurchase)
void	setAllowRemoveAfterInitialPurchase(boolean allowRemoveAfterInitialPurchase)
void	setAttributes(Map<String,Object> attributes)
void	setCategory(ItemChoiceCategory category)	The ItemChoiceCategory which the choice will be chosen from by the customer if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY.
void	setChoiceKey(String choiceKey)
void	setDefaultProduct(ProductDetails defaultProduct)	The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS.
void	setDefaultProductInCategory(ProductDetails defaultProductInCategory)	The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY.
void	setDefaultVariant(VariantDetail defaultVariant)	The default variant that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS.
void	setDiscountAllowed(boolean discountAllowed)
void	setHasPostPurchaseEditRules(boolean hasPostPurchaseEditRules)
void	setItemChoice(ItemChoice itemChoice)
void	setMaximumQuantity(Integer maximumQuantity)
void	setMinimumQuantity(Integer minimumQuantity)
void	setOverridePrice(javax.money.MonetaryAmount overridePrice)
void	setPriceInfo(PriceInfo priceInfo)	Summary of the pricing information related to the choice.
void	setPriceOverridden(boolean priceOverridden)
void	setPricingKey(String pricingKey)
void	setRestrictQtyDecreaseAfterDays(Integer restrictQtyDecreaseAfterDays)
void	setRestrictRemovalAfterDays(Integer restrictRemovalAfterDays)
void	setSelectionType(String selectionType)
void	setSeparateFromPrimaryItem(boolean isSeparateFromPrimaryItem)
void	setSpecificChoices(List<SpecificItemChoiceDetail> specificChoices)	If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from.
void	setSpecificItemChoice(SpecificItemChoiceDetail specificItemChoice)	If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on.
void	setSubscription(boolean isSubscription)
void	setTargetType(String targetType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ItemChoiceDetail

public ItemChoiceDetail(ItemChoice itemChoice,
 ItemChoiceCategory category,
 ProductDetails defaultProductInCategory,
 ProductDetails defaultProduct,
 VariantDetail defaultVariant,
 PriceInfo priceInfo,
 List<SpecificItemChoiceDetail> specificChoices,
 SpecificItemChoiceDetail specificItemChoice)

ItemChoiceDetail

public ItemChoiceDetail()

Method Details

getItemChoice

public ItemChoice getItemChoice()

getCategory

public ItemChoiceCategory getCategory()

The ItemChoiceCategory which the choice will be chosen from by the customer if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY. This will include the products in the category.

Returns:

the category from which the choice will be chosen from or {@link null} if getTargetType() is not DefaultItemChoiceTargetType.CATEGORY. This will include the products in the category.

getDefaultProductInCategory

public ProductDetails getDefaultProductInCategory()

The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY.

Returns:

the defaulted selection for this choice if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY, null otherwise or if there is no default selection

getDefaultProduct

public ProductDetails getDefaultProduct()

The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS. Can be null.

Returns:

the defaulted selection for this choice if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS, null otherwise or if there is no default selection

getDefaultVariant

public VariantDetail getDefaultVariant()

The default variant that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS. Can be null.

Returns:

the defaulted selection for this choice if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS, null otherwise or if there is no default selection

getPriceInfo

public PriceInfo getPriceInfo()

Summary of the pricing information related to the choice.

Returns:

Summary of the pricing information related to the choice

getSpecificChoices

public List<SpecificItemChoiceDetail> getSpecificChoices()

If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from. This also allows for specific override pricing on an item-by-item basis

Returns:

the explicit choices for DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS value of the getTargetType()

getSpecificItemChoice

public SpecificItemChoiceDetail getSpecificItemChoice()

If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on. This also allows for specific override pricing.

Returns:

the explicit choice for DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT value of the getTargetType()

setItemChoice

public void setItemChoice(ItemChoice itemChoice)

setCategory

public void setCategory(ItemChoiceCategory category)

The ItemChoiceCategory which the choice will be chosen from by the customer if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY. This will include the products in the category.

Parameters:

category - the category from which the choice will be chosen from

setDefaultProductInCategory

public void setDefaultProductInCategory(ProductDetails defaultProductInCategory)

The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.CATEGORY.

Parameters:

defaultProduct - the default product that is automatically selected when the getTargetType() is DefaultItemChoiceTargetType.CATEGORY. Should come from within the category

setDefaultProduct

public void setDefaultProduct(ProductDetails defaultProduct)

The default product that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS. Can be null.

Parameters:

defaultProduct - the default product that is automatically selected when the getTargetType() is { DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS. Should come from the specific set of products in specificChoices

setDefaultVariant

public void setDefaultVariant(VariantDetail defaultVariant)

The default variant that can be used when driving customer selections if the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS. Can be null.

Parameters:

defaultVariant - the default variant that is automatically selected when the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS. Should come from the explicit set of variants in specificChoices

setPriceInfo

public void setPriceInfo(PriceInfo priceInfo)

Summary of the pricing information related to the choice.

Parameters:

priceInfo - Summary of the pricing information related to the choice

setSpecificChoices

public void setSpecificChoices(List<SpecificItemChoiceDetail> specificChoices)

If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from. This also allows for specific override pricing on an item-by-item basis

Parameters:

specificChoices - manually-curated options for the user to choose from for this choice

setSpecificItemChoice

public void setSpecificItemChoice(SpecificItemChoiceDetail specificItemChoice)

If the getTargetType() is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on. This also allows for specific override pricing.

Parameters:

specificChoice - manually selected option for the user to choose to add on

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

getAttribute

public <T> T getAttribute(String name)

getDefaultPrice

public javax.money.MonetaryAmount getDefaultPrice()

getDefaultChoicePrice

public javax.money.MonetaryAmount getDefaultChoicePrice()

getDefaultChoiceOverridePrice

public javax.money.MonetaryAmount getDefaultChoiceOverridePrice()

getDefaultChoiceUnderlyingSku

public String getDefaultChoiceUnderlyingSku()

getDefaultChoiceUnderlyingPricingKey

public String getDefaultChoiceUnderlyingPricingKey()

getDefaultChoiceUnderlyingDefaultTerm

public ProductTerm getDefaultChoiceUnderlyingDefaultTerm()

getDefaultChoicePricingKey

public String getDefaultChoicePricingKey()

isDiscountAllowed

public boolean isDiscountAllowed()

getTargetType

public String getTargetType()

getSelectionType

public String getSelectionType()

getChoiceKey

public String getChoiceKey()

getMaximumQuantity

public Integer getMaximumQuantity()

getMinimumQuantity

public Integer getMinimumQuantity()

getOverridePrice

public javax.money.MonetaryAmount getOverridePrice()

getPricingKey

public String getPricingKey()

isPriceOverridden

public boolean isPriceOverridden()

getAttributes

public Map<String,Object> getAttributes()

isSubscription

public boolean isSubscription()

isHasPostPurchaseEditRules

public boolean isHasPostPurchaseEditRules()

isAllowEditAfterInitialPurchase

public boolean isAllowEditAfterInitialPurchase()

isAllowQtyEditAfterInitialPurchase

public boolean isAllowQtyEditAfterInitialPurchase()

isAllowAddAfterInitialPurchase

public boolean isAllowAddAfterInitialPurchase()

isAllowRemoveAfterInitialPurchase

public boolean isAllowRemoveAfterInitialPurchase()

getRestrictQtyDecreaseAfterDays

public Integer getRestrictQtyDecreaseAfterDays()

getRestrictRemovalAfterDays

public Integer getRestrictRemovalAfterDays()

isSeparateFromPrimaryItem

public boolean isSeparateFromPrimaryItem()

setTargetType

public void setTargetType(String targetType)

setSelectionType

public void setSelectionType(String selectionType)

setChoiceKey

public void setChoiceKey(String choiceKey)

setMaximumQuantity

public void setMaximumQuantity(Integer maximumQuantity)

setMinimumQuantity

public void setMinimumQuantity(Integer minimumQuantity)

setOverridePrice

public void setOverridePrice(javax.money.MonetaryAmount overridePrice)

setDiscountAllowed

public void setDiscountAllowed(boolean discountAllowed)

setPricingKey

public void setPricingKey(String pricingKey)

setPriceOverridden

public void setPriceOverridden(boolean priceOverridden)

setAttributes

public void setAttributes(Map<String,Object> attributes)

setSubscription

public void setSubscription(boolean isSubscription)

setHasPostPurchaseEditRules

public void setHasPostPurchaseEditRules(boolean hasPostPurchaseEditRules)

setAllowEditAfterInitialPurchase

public void setAllowEditAfterInitialPurchase(boolean allowEditAfterInitialPurchase)

setAllowQtyEditAfterInitialPurchase

public void setAllowQtyEditAfterInitialPurchase(boolean allowQtyEditAfterInitialPurchase)

setAllowAddAfterInitialPurchase

public void setAllowAddAfterInitialPurchase(boolean allowAddAfterInitialPurchase)

setAllowRemoveAfterInitialPurchase

public void setAllowRemoveAfterInitialPurchase(boolean allowRemoveAfterInitialPurchase)

setRestrictQtyDecreaseAfterDays

public void setRestrictQtyDecreaseAfterDays(Integer restrictQtyDecreaseAfterDays)

setRestrictRemovalAfterDays

public void setRestrictRemovalAfterDays(Integer restrictRemovalAfterDays)

setSeparateFromPrimaryItem

public void setSeparateFromPrimaryItem(boolean isSeparateFromPrimaryItem)