Class ProductOption
java.lang.Object
com.broadleafcommerce.cartoperation.domain.ProductOption
- All Implemented Interfaces:
Serializable
A "product option" encapsulates additional, variable information about a
Product
explicitly designed for customer-facing input. This can be info necessary for distinguishing
particular variants
such as shirt size, color, or material, or it can be some
custom user-input such as a name to emboss on the back of a jersey. Finally, it can even drive
additional products that should be added to the cart along with the product that it is configured
for.- Author:
- Chad Harchar (charchar)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(String name, Object value) Takes in any additional attributes passed in the request not matching any defined properties.protected boolean
boolean
Return any additional attributes passed in the request not matching any defined properties.Configuration when thetype
of this option is one of:ProductOptionType.VARIANT_DISTINGUISHING
- drives customer further specifying their choices into a specificVariant
that contains a unique SKU code, pricing concerns, etc.ProductOptionType.CART_ITEM_ATTRIBUTE
- Customer input will flow directly in the item attributes within their cartProductOptionType.CART_ATTRIBUTE
.Map holding any additional attributes passed in the request not matching any defined properties.Configuration for theProductOptionType.ITEM_CHOICE
.getLabel()
The label shown to customers when displaying this option.getType()
Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.int
hashCode()
void
setAttributeChoice
(AttributeChoice attributeChoice) Configuration when thetype
of this option is one of:ProductOptionType.VARIANT_DISTINGUISHING
- drives customer further specifying their choices into a specificVariant
that contains a unique SKU code, pricing concerns, etc.ProductOptionType.CART_ITEM_ATTRIBUTE
- Customer input will flow directly in the item attributes within their cartProductOptionType.CART_ATTRIBUTE
.void
setAttributes
(Map<String, Object> attributes) Map holding any additional attributes passed in the request not matching any defined properties.void
setItemChoice
(ItemChoice itemChoice) Configuration for theProductOptionType.ITEM_CHOICE
.void
The label shown to customers when displaying this option.void
Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.toString()
-
Constructor Details
-
ProductOption
public ProductOption()
-
-
Method Details
-
addAttribute
Takes in any additional attributes passed in the request not matching any defined properties.- Parameters:
name
- Name of the additional attributevalue
- Value of the additional attribute
-
getAttribute
Return any additional attributes passed in the request not matching any defined properties.- Returns:
- any additional attributes passed in the request not matching any defined properties.
-
getType
Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.- Returns:
- which type of input this option is configured for
- See Also:
-
getLabel
The label shown to customers when displaying this option. This helps communicate to customers how they should fill out the input- Returns:
- the display shown to customer for this option
-
getItemChoice
Configuration for theProductOptionType.ITEM_CHOICE
. Drives customer selection of an additional item to add to their cart- Returns:
- configuration if the type of this option is an
ProductOptionType.ITEM_CHOICE
, otherwise null
-
getAttributeChoice
Configuration when the
type
of this option is one of:ProductOptionType.VARIANT_DISTINGUISHING
- drives customer further specifying their choices into a specificVariant
that contains a unique SKU code, pricing concerns, etc.ProductOptionType.CART_ITEM_ATTRIBUTE
- Customer input will flow directly in the item attributes within their cartProductOptionType.CART_ATTRIBUTE
. Customer input will flow directly in the global cart attribute. Any previously-set attribute should be replaced with new values.
- Returns:
- attributeChoice if the type of this option is an
ProductOptionType.VARIANT_DISTINGUISHING
,ProductOptionType.CART_ITEM_ATTRIBUTE
orProductOptionType.CART_ATTRIBUTE
, otherwise null
-
getAttributes
Map holding any additional attributes passed in the request not matching any defined properties. -
setType
Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.- Parameters:
type
- the type of input that the drives customer selection, defaults fromProductOptionType
- See Also:
-
setLabel
The label shown to customers when displaying this option. This helps communicate to customers how they should fill out the input- Parameters:
label
- the display shown to customers for this option
-
setItemChoice
Configuration for theProductOptionType.ITEM_CHOICE
. Drives customer selection of an additional item to add to their cart- Parameters:
itemChoice
- configuration only whentype
isProductOptionType.ITEM_CHOICE
-
setAttributeChoice
Configuration when the
type
of this option is one of:ProductOptionType.VARIANT_DISTINGUISHING
- drives customer further specifying their choices into a specificVariant
that contains a unique SKU code, pricing concerns, etc.ProductOptionType.CART_ITEM_ATTRIBUTE
- Customer input will flow directly in the item attributes within their cartProductOptionType.CART_ATTRIBUTE
. Customer input will flow directly in the global cart attribute. Any previously-set attribute should be replaced with new values.
- Parameters:
attributeChoice
- configuration for customer-driven values that flow into an attribute
-
setAttributes
Map holding any additional attributes passed in the request not matching any defined properties. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-