ProductOptionImpl (BroadleafCommerce Framework 3.0.0-GA-ETS-SPRING-4-M2 API)

java.lang.Object
- org.broadleafcommerce.core.catalog.domain.ProductOptionImpl

All Implemented Interfaces:: java.io.Serializable, AdminMainEntity, ProductOption

@Entity
public class ProductOptionImpl
extends java.lang.Object
implements ProductOption, AdminMainEntity

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<ProductOptionValue>`	`allowedValues`
`protected java.lang.String`	`attributeName`
`protected java.lang.Integer`	`displayOrder`
`protected java.lang.String`	`errorCode`
`protected java.lang.String`	`errorMessage`
`protected java.lang.Long`	`id`
`protected java.lang.String`	`label`
`protected java.util.List<Product>`	`products`
`protected java.lang.Boolean`	`required`
`protected java.lang.String`	`type`
`protected java.lang.String`	`validationString`

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

Constructor Summary

Constructors
Constructor and Description

ProductOptionImpl()

Constructors
Constructor and Description
`ProductOptionImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<ProductOptionValue>`	`getAllowedValues()` Gets the available values that a user can select for this ProductOption.
`java.lang.String`	`getAttributeName()` Gets the attribute name for where the ProductOptionValue selected for this ProductOption is stored in the OrderItemAttributes for the OrderItem
`java.lang.Integer`	`getDisplayOrder()` Gets the display order of this option in relation to the other `ProductOption`s
`java.lang.String`	`getErrorCode()`
`java.lang.String`	`getErrorMessage()`
`java.lang.Long`	`getId()` Returns unique identifier of the product option.
`java.lang.String`	`getLabel()` The label to show to the user when selecting from the available `ProductOptionValue`s.
`java.lang.String`	`getMainEntityName()`
`ProductOptionValidationType`	`getProductOptionValidationType()`
`java.util.List<Product>`	`getProducts()` Gets all the Products associated with this ProductOption
`java.lang.Boolean`	`getRequired()`
`ProductOptionType`	`getType()` Returns the option type.
`java.lang.Boolean`	`getUseInSkuGeneration()`
`java.lang.String`	`getValidationString()`
`void`	`setAllowedValues(java.util.List<ProductOptionValue> allowedValues)` Set the allowed values for this ProductOption
`void`	`setAttributeName(java.lang.String attributeName)` Sets the attribute name that will be used in storing the selected ProductOptionValue for this ProductOption
`void`	`setDisplayOrder(java.lang.Integer displayOrder)` Gets the display order of this option in relation to the other `ProductOption`s
`void`	`setErrorCode(java.lang.String errorCode)`
`void`	`setErrorMessage(java.lang.String errorMessage)`
`void`	`setId(java.lang.Long id)` Sets the unique identifier of the product option.
`void`	`setLabel(java.lang.String label)` Sets the label to show the user when selecting from the available `ProductOptionValue`s
`void`	`setProductOptionValidationType(ProductOptionValidationType productOptionValidationType)`
`void`	`setProducts(java.util.List<Product> products)` Set the Products to associate with this ProductOption
`void`	`setRequired(java.lang.Boolean required)` Sets whether or not
`void`	`setType(ProductOptionType type)` Sets the option type.
`void`	`setUseInSkuGeneration(java.lang.Boolean useInSkuGeneration)`
`void`	`setValidationString(java.lang.String validationString)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected java.lang.Long id
```
  - type
```
protected java.lang.String type
```
  - attributeName
```
protected java.lang.String attributeName
```
  - label
```
protected java.lang.String label
```
  - required
```
protected java.lang.Boolean required
```
  - displayOrder
```
protected java.lang.Integer displayOrder
```
  - validationString
```
protected java.lang.String validationString
```
  - errorCode
```
protected java.lang.String errorCode
```
  - errorMessage
```
protected java.lang.String errorMessage
```
  - allowedValues
```
protected java.util.List<ProductOptionValue> allowedValues
```
  - products
```
protected java.util.List<Product> products
```
- Constructor Detail
  - ProductOptionImpl
```
public ProductOptionImpl()
```
- Method Detail
  - getId
```
public java.lang.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(java.lang.Long id)
```
    Description copied from interface: ProductOption
    
    Sets the unique identifier of the product option.
    
    Specified by:
    
    setId 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 java.lang.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
    
    See Also:
    
    OrderItemAttribute}, {@link OrderItem}
  - setAttributeName
```
public void setAttributeName(java.lang.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 java.lang.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(java.lang.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 java.lang.Boolean getRequired()
```
    Specified by:
    
    getRequired in interface ProductOption
    
    Returns:
    
    whether or not this ProductOption is required
  - setRequired
```
public void setRequired(java.lang.Boolean required)
```
    Description copied from interface: ProductOption
    
    Sets whether or not
    
    Specified by:
    
    setRequired in interface ProductOption
  - getDisplayOrder
```
public java.lang.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(java.lang.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
  - getProducts
```
public java.util.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(java.util.List<Product> products)
```
    Description copied from interface: ProductOption
    
    Set the Products to associate with this ProductOption
    
    Specified by:
    
    setProducts in interface ProductOption
  - getAllowedValues
```
public java.util.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(java.util.List<ProductOptionValue> allowedValues)
```
    Description copied from interface: ProductOption
    
    Set the allowed values for this ProductOption
    
    Specified by:
    
    setAllowedValues in interface ProductOption
  - getUseInSkuGeneration
```
public java.lang.Boolean getUseInSkuGeneration()
```
    Specified by:
    
    getUseInSkuGeneration in interface ProductOption
  - setUseInSkuGeneration
```
public void setUseInSkuGeneration(java.lang.Boolean useInSkuGeneration)
```
    Specified by:
    
    setUseInSkuGeneration 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 java.lang.String getValidationString()
```
    Specified by:
    
    getValidationString in interface ProductOption
  - setValidationString
```
public void setValidationString(java.lang.String validationString)
```
    Specified by:
    
    setValidationString in interface ProductOption
  - getErrorCode
```
public java.lang.String getErrorCode()
```
    Specified by:
    
    getErrorCode in interface ProductOption
  - setErrorCode
```
public void setErrorCode(java.lang.String errorCode)
```
    Specified by:
    
    setErrorCode in interface ProductOption
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface ProductOption
  - setErrorMessage
```
public void setErrorMessage(java.lang.String errorMessage)
```
    Specified by:
    
    setErrorMessage in interface ProductOption
  - getMainEntityName
```
public java.lang.String getMainEntityName()
```
    Specified by:
    
    getMainEntityName in interface AdminMainEntity

Class ProductOptionImpl

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

type

attributeName

label

required

displayOrder

validationString

errorCode

errorMessage

allowedValues

products

Constructor Detail

ProductOptionImpl

Method Detail

getId

setId

getType

setType

getAttributeName

setAttributeName

getLabel

setLabel

getRequired

setRequired

getDisplayOrder

setDisplayOrder

getProducts

setProducts

getAllowedValues

setAllowedValues

getUseInSkuGeneration

setUseInSkuGeneration

getProductOptionValidationType

setProductOptionValidationType

getValidationString

setValidationString

getErrorCode

setErrorCode

getErrorMessage

setErrorMessage

getMainEntityName