Package org.broadleafcommerce.core.catalog.domain

Class ProductOptionImpl

java.lang.Object

org.broadleafcommerce.core.catalog.domain.ProductOptionImpl

All Implemented Interfaces:

Serializable, AdminMainEntity, MultiTenantCloneable<ProductOption>, ProductOption, ProductOptionAdminPresentation

@Entity
public class ProductOptionImpl
extends Object
implements ProductOption, AdminMainEntity, ProductOptionAdminPresentation

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.broadleafcommerce.core.catalog.domain.ProductOptionAdminPresentation

ProductOptionAdminPresentation.FieldOrder, ProductOptionAdminPresentation.GroupName, ProductOptionAdminPresentation.GroupOrder, ProductOptionAdminPresentation.TabName, ProductOptionAdminPresentation.TabOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ProductOptionValue>	allowedValues
protected String	attributeName
protected Integer	displayOrder
protected String	errorCode
protected String	errorMessage
protected Long	id
protected String	label
protected String	longDescription
protected String	name
protected List<ProductOptionXref>	products
protected Boolean	required
protected String	type
protected String	validationString

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

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ProductOptionImpl()

Method Summary

Modifier and Type	Method	Description
<G extends ProductOption> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context)
boolean	equals(Object obj)
List<ProductOptionValue>	getAllowedValues()	Gets the available values that a user can select for this ProductOption.
String	getAttributeName()	Gets the attribute name for where the ProductOptionValue selected for this ProductOption is stored in the OrderItemAttributes for the OrderItem
Integer	getDisplayOrder()	Gets the display order of this option in relation to the other ProductOptions
String	getErrorCode()
String	getErrorMessage()
Long	getId()	Returns unique identifier of the product option.
String	getLabel()	The label to show to the user when selecting from the available ProductOptionValues.
String	getLongDescription()
String	getMainEntityName()
String	getName()	Returns name of the product option.
ProductOptionValidationStrategyType	getProductOptionValidationStrategyType()
ProductOptionValidationType	getProductOptionValidationType()
List<Product>	getProducts()	Gets all the Products associated with this ProductOption
List<ProductOptionXref>	getProductXrefs()
Boolean	getRequired()
ProductOptionType	getType()	Returns the option type.
Boolean	getUseInSkuGeneration()
String	getValidationString()
int	hashCode()
void	setAllowedValues(List<ProductOptionValue> allowedValues)	Set the allowed values for this ProductOption
void	setAttributeName(String attributeName)	Sets the attribute name that will be used in storing the selected ProductOptionValue for this ProductOption
void	setDisplayOrder(Integer displayOrder)	Gets the display order of this option in relation to the other ProductOptions
void	setErrorCode(String errorCode)
void	setErrorMessage(String errorMessage)
void	setId(Long id)	Sets the unique identifier of the product option.
void	setLabel(String label)	Sets the label to show the user when selecting from the available ProductOptionValues
void	setLongDescription(String longDescription)
void	setName(String name)	Sets the name of the product option.
void	setProductOptionValidationStrategyType(ProductOptionValidationStrategyType productOptionValidationStrategyType)
void	setProductOptionValidationType(ProductOptionValidationType productOptionValidationType)
void	setProducts(List<Product> products)	Set the Products to associate with this ProductOption
void	setProductXrefs(List<ProductOptionXref> xrefs)
void	setRequired(Boolean required)	Sets whether or not
void	setType(ProductOptionType type)	Sets the option type.
void	setUseInSkuGeneration(Boolean useInSkuGeneration)
void	setValidationString(String validationString)

Methods inherited from class java.lang.Object

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

Field Details

id

protected Long id

name

protected String name

type

protected String type

attributeName

protected String attributeName

label

protected String label

required

protected Boolean required

displayOrder

protected Integer displayOrder

validationString

protected String validationString

errorCode

protected String errorCode

errorMessage

protected String errorMessage

allowedValues

protected List<ProductOptionValue> allowedValues

longDescription

protected String longDescription

products

protected List<ProductOptionXref> products

Constructor Details

ProductOptionImpl

public ProductOptionImpl()

Method Details

getId

public Long getId()

Description copied from interface: ProductOption

Returns unique identifier of the product option.

Specified by:

getId in interface ProductOption

Returns:

setId

public void setId(Long id)

Description copied from interface: ProductOption

Sets the unique identifier of the product option.

Specified by:

setId in interface ProductOption

getName

public String getName()

Description copied from interface: ProductOption

Returns name of the product option.

Specified by:

getName in interface ProductOption

Returns:

setName

public void setName(String name)

Description copied from interface: ProductOption

Sets the name of the product option.

Specified by:

setName in interface ProductOption

getType

public ProductOptionType getType()

Description copied from interface: ProductOption

Returns the option type. For example, "color", "size", etc. These are used primarily to determine how the UI should prompt for and validate the product option.

Specified by:

getType in interface ProductOption

Returns:

setType

public void setType(ProductOptionType type)

Description copied from interface: ProductOption

Sets the option type. This is primarily used for display to render the option selection.

Specified by:

setType in interface ProductOption

getAttributeName

public String getAttributeName()

Description copied from interface: ProductOption

Gets the attribute name for where the ProductOptionValue selected for this ProductOption is stored in the OrderItemAttributes for the OrderItem

Specified by:

getAttributeName in interface ProductOption

Returns:

the name of the OrderItemAttribute to store the selected ProductOptionValue in the Order domain

setAttributeName

public void setAttributeName(String attributeName)

Description copied from interface: ProductOption

Sets the attribute name that will be used in storing the selected ProductOptionValue for this ProductOption

Specified by:

setAttributeName in interface ProductOption

Parameters:

attributeName - - the name of the OrderItemAttribute to store the selected ProductOptionValue in the Order domain

getLabel

public String getLabel()

Description copied from interface: ProductOption

The label to show to the user when selecting from the available ProductOptionValues. This might be "Color" or "Size"

Specified by:

getLabel in interface ProductOption

Returns:

setLabel

public void setLabel(String label)

Description copied from interface: ProductOption

Sets the label to show the user when selecting from the available ProductOptionValues

Specified by:

setLabel in interface ProductOption

getRequired

public Boolean getRequired()

Specified by:

getRequired in interface ProductOption

Returns:

whether or not this ProductOption is required

setRequired

public void setRequired(Boolean required)

Description copied from interface: ProductOption

Sets whether or not

Specified by:

setRequired in interface ProductOption

getDisplayOrder

public Integer getDisplayOrder()

Description copied from interface: ProductOption

Gets the display order of this option in relation to the other ProductOptions

Specified by:

getDisplayOrder in interface ProductOption

Returns:

setDisplayOrder

public void setDisplayOrder(Integer displayOrder)

Description copied from interface: ProductOption

Gets the display order of this option in relation to the other ProductOptions

Specified by:

setDisplayOrder in interface ProductOption

getProductXrefs

public List<ProductOptionXref> getProductXrefs()

Specified by:

getProductXrefs in interface ProductOption

setProductXrefs

public void setProductXrefs(List<ProductOptionXref> xrefs)

Specified by:

setProductXrefs in interface ProductOption

getProducts

public List<Product> getProducts()

Description copied from interface: ProductOption

Gets all the Products associated with this ProductOption

Specified by:

getProducts in interface ProductOption

Returns:

the Products associated with this ProductOption

setProducts

public void setProducts(List<Product> products)

Description copied from interface: ProductOption

Set the Products to associate with this ProductOption

Specified by:

setProducts in interface ProductOption

getAllowedValues

public List<ProductOptionValue> getAllowedValues()

Description copied from interface: ProductOption

Gets the available values that a user can select for this ProductOption. This value will be stored in OrderItemAttributes at the OrderItem level. The OrderItemAttribute name will be whatever was returned from ProductOption.getAttributeName()

Specified by:

getAllowedValues in interface ProductOption

Returns:

the allowed values for this ProductOption

setAllowedValues

public void setAllowedValues(List<ProductOptionValue> allowedValues)

Description copied from interface: ProductOption

Set the allowed values for this ProductOption

Specified by:

setAllowedValues in interface ProductOption

getUseInSkuGeneration

public Boolean getUseInSkuGeneration()

Specified by:

getUseInSkuGeneration in interface ProductOption

setUseInSkuGeneration

public void setUseInSkuGeneration(Boolean useInSkuGeneration)

Specified by:

setUseInSkuGeneration in interface ProductOption

getProductOptionValidationStrategyType

public ProductOptionValidationStrategyType getProductOptionValidationStrategyType()

Specified by:

getProductOptionValidationStrategyType in interface ProductOption

setProductOptionValidationStrategyType

public void setProductOptionValidationStrategyType(ProductOptionValidationStrategyType productOptionValidationStrategyType)

Specified by:

setProductOptionValidationStrategyType in interface ProductOption

getProductOptionValidationType

public ProductOptionValidationType getProductOptionValidationType()

Specified by:

getProductOptionValidationType in interface ProductOption

setProductOptionValidationType

public void setProductOptionValidationType(ProductOptionValidationType productOptionValidationType)

Specified by:

setProductOptionValidationType in interface ProductOption

getValidationString

public String getValidationString()

Specified by:

getValidationString in interface ProductOption

setValidationString

public void setValidationString(String validationString)

Specified by:

setValidationString in interface ProductOption

getErrorCode

public String getErrorCode()

Specified by:

getErrorCode in interface ProductOption

setErrorCode

public void setErrorCode(String errorCode)

Specified by:

setErrorCode in interface ProductOption

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface ProductOption

setErrorMessage

public void setErrorMessage(String errorMessage)

Specified by:

setErrorMessage in interface ProductOption

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface AdminMainEntity

getLongDescription

public String getLongDescription()

Specified by:

getLongDescription in interface ProductOption

setLongDescription

public void setLongDescription(String longDescription)

Specified by:

setLongDescription in interface ProductOption

createOrRetrieveCopyInstance

public <G extends ProductOption> CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                                         throws CloneNotSupportedException

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<ProductOption>

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object