OptionIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

Option
```
public interface OptionIf
```
A product contains an array of these option objects. An option is used to configure a product and may change the price of a product. i.e. The amount of memory or CPU specification for a personal computer.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrCustom1()` Custom field that can take a unique value whenever the option is connected to a product.
`java.lang.String`	`getAttrCustom2()` Custom field that can take a unique value whenever the option is connected to a product.
`int`	`getAttrId()` The id of the record in the products_attributes table.
`java.lang.String`	`getCode()` The code of the option.
`java.math.BigDecimal`	`getCustomerPrice()` Only applicable in the case where the option is of type TYPE_CUSTOMER_PRICE.
`java.lang.String`	`getCustomerText()` Only applicable in the case where the option is of type TYPE_CUSTOMER_TEXT.
`java.math.BigDecimal`	`getExtPrice0()`
`java.math.BigDecimal`	`getExtPrice1()`
`java.math.BigDecimal`	`getExtPrice2()`
`java.math.BigDecimal`	`getExtPrice3()`
`int`	`getId()` The id of the record in the products_options table.
`java.lang.String`	`getName()` The name of the option.
`java.lang.String`	`getOptionCustom1()` Custom field, the value of which is defined when the option is created.
`java.lang.String`	`getOptionCustom2()` Custom field, the value of which is defined when the option is created.
`java.lang.String`	`getOptionValCustom1()` Custom field, the value of which is defined when the option value is created.
`java.lang.String`	`getOptionValCustom2()` Custom field, the value of which is defined when the option value is created.
`java.math.BigDecimal`	`getPrice0()`
`java.math.BigDecimal`	`getPrice1()`
`java.math.BigDecimal`	`getPrice2()`
`java.math.BigDecimal`	`getPrice3()`
`java.math.BigDecimal`	`getPriceExTax()`
`java.math.BigDecimal`	`getPriceIncTax()`
`int`	`getQuantity()` Only applicable in the case where the option is of type TYPE_VARIABLE_QUANTITY.
`int`	`getSortOrder()` Determines the sort order of the options
`int`	`getType()` The type of option.
`java.lang.String`	`getValue()` The value of the option.
`java.lang.String`	`getValueCode()` The code of the option value.
`int`	`getValueId()` The id of the record in the products_options_values table.
`void`	`setAttrCustom1(java.lang.String attrCustom1)` Custom field that can take a unique value whenever the option is connected to a product.
`void`	`setAttrCustom2(java.lang.String attrCustom2)` Custom field that can take a unique value whenever the option is connected to a product.
`void`	`setAttrId(int attrId)` The id of the record in the products_attributes table.
`void`	`setCode(java.lang.String code)` The code of the option.
`void`	`setCustomerPrice(java.math.BigDecimal customerPrice)` Only applicable in the case where the option is of type TYPE_CUSTOMER_PRICE.
`void`	`setCustomerText(java.lang.String customerText)` Only applicable in the case where the option is of type TYPE_CUSTOMER_TEXT.
`void`	`setExtPrice0(java.math.BigDecimal extPrice0)`
`void`	`setExtPrice1(java.math.BigDecimal extPrice1)`
`void`	`setExtPrice2(java.math.BigDecimal extPrice2)`
`void`	`setExtPrice3(java.math.BigDecimal extPrice3)`
`void`	`setId(int id)` The id of the record in the products_options table.
`void`	`setName(java.lang.String name)` The name of the option.
`void`	`setOptionCustom1(java.lang.String optionCustom1)` Custom field, the value of which is defined when the option is created.
`void`	`setOptionCustom2(java.lang.String optionCustom2)` Custom field, the value of which is defined when the option is created.
`void`	`setOptionValCustom1(java.lang.String optionValCustom1)` Custom field, the value of which is defined when the option value is created.
`void`	`setOptionValCustom2(java.lang.String optionValCustom2)` Custom field, the value of which is defined when the option value is created.
`void`	`setPrice0(java.math.BigDecimal price0)`
`void`	`setPrice1(java.math.BigDecimal price1)`
`void`	`setPrice2(java.math.BigDecimal price2)`
`void`	`setPrice3(java.math.BigDecimal price3)`
`void`	`setPriceExTax(java.math.BigDecimal priceExTax)`
`void`	`setPriceIncTax(java.math.BigDecimal priceIncTax)`
`void`	`setQuantity(int quantity)` Only applicable in the case where the option is of type TYPE_VARIABLE_QUANTITY.
`void`	`setSortOrder(int sortOrder)` Determines the sort order of the options
`void`	`setType(int type)` The type of option.
`void`	`setValue(java.lang.String value)` The value of the option.
`void`	`setValueCode(java.lang.String valueCode)` The code of the option value.
`void`	`setValueId(int valueId)` The id of the record in the products_options_values table.

- Method Detail
  - getName
```
java.lang.String getName()
```
    The name of the option. e.g color or size.
    
    Returns:
    
    Returns the name.
  - setName
```
void setName(java.lang.String name)
```
    The name of the option. e.g color or size.
    
    Parameters:
    
    name - The name to set.
  - getCode
```
java.lang.String getCode()
```
    The code of the option. Used for creating the name of the option image.
    
    Returns:
    
    the code
  - setCode
```
void setCode(java.lang.String code)
```
    The code of the option. Used for creating the name of the option image.
    
    Parameters:
    
    code - the code to set
  - getValue
```
java.lang.String getValue()
```
    The value of the option. e.g red, blue or small, large.
    
    Returns:
    
    Returns the value.
  - setValue
```
void setValue(java.lang.String value)
```
    The value of the option. e.g red, blue or small, large.
    
    Parameters:
    
    value - The value to set.
  - getValueCode
```
java.lang.String getValueCode()
```
    The code of the option value. Used for creating the name of the option image.
    
    Returns:
    
    the valueCode
  - setValueCode
```
void setValueCode(java.lang.String valueCode)
```
    The code of the option value. Used for creating the name of the option image.
    
    Parameters:
    
    valueCode - the valueCode to set
  - getValueId
```
int getValueId()
```
    The id of the record in the products_options_values table.
    
    Returns:
    
    Returns the valueId.
  - setValueId
```
void setValueId(int valueId)
```
    The id of the record in the products_options_values table.
    
    Parameters:
    
    valueId - The valueId to set.
  - getId
```
int getId()
```
    The id of the record in the products_options table.
    
    Returns:
    
    Returns the id.
  - setId
```
void setId(int id)
```
    The id of the record in the products_options table.
    
    Parameters:
    
    id - The id to set.
  - getAttrId
```
int getAttrId()
```
    The id of the record in the products_attributes table.
    
    Returns:
    
    the attrId
  - setAttrId
```
void setAttrId(int attrId)
```
    The id of the record in the products_attributes table.
    
    Parameters:
    
    attrId - the attrId to set
  - getPriceExTax
```
java.math.BigDecimal getPriceExTax()
```
    Returns:
    
    Returns the priceExTax.
  - setPriceExTax
```
void setPriceExTax(java.math.BigDecimal priceExTax)
```
    Parameters:
    
    priceExTax - The priceExTax to set.
  - getPriceIncTax
```
java.math.BigDecimal getPriceIncTax()
```
    Returns:
    
    Returns the priceIncTax.
  - setPriceIncTax
```
void setPriceIncTax(java.math.BigDecimal priceIncTax)
```
    Parameters:
    
    priceIncTax - The priceIncTax to set.
  - getPrice0
```
java.math.BigDecimal getPrice0()
```
    Returns:
    
    Returns the price0.
  - setPrice0
```
void setPrice0(java.math.BigDecimal price0)
```
    Parameters:
    
    price0 - The price0 to set.
  - getPrice1
```
java.math.BigDecimal getPrice1()
```
    Returns:
    
    Returns the price1.
  - setPrice1
```
void setPrice1(java.math.BigDecimal price1)
```
    Parameters:
    
    price1 - The price1 to set.
  - getPrice2
```
java.math.BigDecimal getPrice2()
```
    Returns:
    
    Returns the price2.
  - setPrice2
```
void setPrice2(java.math.BigDecimal price2)
```
    Parameters:
    
    price2 - The price2 to set.
  - getPrice3
```
java.math.BigDecimal getPrice3()
```
    Returns:
    
    Returns the price3.
  - setPrice3
```
void setPrice3(java.math.BigDecimal price3)
```
    Parameters:
    
    price3 - The price3 to set.
  - getAttrCustom1
```
java.lang.String getAttrCustom1()
```
    Custom field that can take a unique value whenever the option is connected to a product.
    
    Returns:
    
    the attrCustom1
  - setAttrCustom1
```
void setAttrCustom1(java.lang.String attrCustom1)
```
    Custom field that can take a unique value whenever the option is connected to a product.
    
    Parameters:
    
    attrCustom1 - the attrCustom1 to set
  - getAttrCustom2
```
java.lang.String getAttrCustom2()
```
    Custom field that can take a unique value whenever the option is connected to a product.
    
    Returns:
    
    the attrCustom2
  - setAttrCustom2
```
void setAttrCustom2(java.lang.String attrCustom2)
```
    Custom field that can take a unique value whenever the option is connected to a product.
    
    Parameters:
    
    attrCustom2 - the attrCustom2 to set
  - getOptionCustom1
```
java.lang.String getOptionCustom1()
```
    Custom field, the value of which is defined when the option is created.
    
    Returns:
    
    the optionCustom1
  - setOptionCustom1
```
void setOptionCustom1(java.lang.String optionCustom1)
```
    Custom field, the value of which is defined when the option is created.
    
    Parameters:
    
    optionCustom1 - the optionCustom1 to set
  - getOptionCustom2
```
java.lang.String getOptionCustom2()
```
    Custom field, the value of which is defined when the option is created.
    
    Returns:
    
    the optionCustom2
  - setOptionCustom2
```
void setOptionCustom2(java.lang.String optionCustom2)
```
    Custom field, the value of which is defined when the option is created.
    
    Parameters:
    
    optionCustom2 - the optionCustom2 to set
  - getOptionValCustom1
```
java.lang.String getOptionValCustom1()
```
    Custom field, the value of which is defined when the option value is created.
    
    Returns:
    
    the optionValCustom1
  - setOptionValCustom1
```
void setOptionValCustom1(java.lang.String optionValCustom1)
```
    Custom field, the value of which is defined when the option value is created.
    
    Parameters:
    
    optionValCustom1 - the optionValCustom1 to set
  - getOptionValCustom2
```
java.lang.String getOptionValCustom2()
```
    Custom field, the value of which is defined when the option value is created.
    
    Returns:
    
    the optionValCustom2
  - setOptionValCustom2
```
void setOptionValCustom2(java.lang.String optionValCustom2)
```
    Custom field, the value of which is defined when the option value is created.
    
    Parameters:
    
    optionValCustom2 - the optionValCustom2 to set
  - getType
```
int getType()
```
    The type of option. Valid types are
    - TYPE_SIMPLE - Standard type where the option may or may not change the price of the product.
    - TYPE_VARIABLE_QUANTITY - A quantity may be defined for the option (i.e. Number of megabytes). The price defined will be multiplied by the quantity since it is a unit price.
    - TYPE_CUSTOMER_PRICE - A customer may enter the price for the option. Can be used for donations.
    - TYPE_CUSTOMER_TEXT - A customer may enter text for the option to personalize a product.
    Returns:
    
    the type
  - setType
```
void setType(int type)
```
    The type of option. Valid types are
    - TYPE_SIMPLE - Standard type where the option may or may not change the price of the product.
    - TYPE_VARIABLE_QUANTITY - A quantity may be defined for the option (i.e. Number of megabytes). The price defined will be multiplied by the quantity since it is a unit price.
    - TYPE_CUSTOMER_PRICE - A customer may enter the price for the option. Can be used for donations.
    - TYPE_CUSTOMER_TEXT - A customer may enter text for the option to personalize a product.
    Parameters:
    
    type - the type to set
  - getQuantity
```
int getQuantity()
```
    Only applicable in the case where the option is of type TYPE_VARIABLE_QUANTITY. In this case a quantity may be defined for the option which will be multiplied by the unit price in order to calculate the total option price.
    
    Returns:
    
    the quantity
  - setQuantity
```
void setQuantity(int quantity)
```
    Only applicable in the case where the option is of type TYPE_VARIABLE_QUANTITY. In this case a quantity may be defined for the option which will be multiplied by the unit price in order to calculate the total option price.
    
    Parameters:
    
    quantity - the quantity to set
  - getCustomerPrice
```
java.math.BigDecimal getCustomerPrice()
```
    Only applicable in the case where the option is of type TYPE_CUSTOMER_PRICE. In this case the customer may define the price of the option. An example of where this functionality may be useful is for donations.
    
    Returns:
    
    the customerPrice
  - setCustomerPrice
```
void setCustomerPrice(java.math.BigDecimal customerPrice)
```
    Only applicable in the case where the option is of type TYPE_CUSTOMER_PRICE. In this case the customer may define the price of the option. An example of where this functionality may be useful is for donations.
    
    Parameters:
    
    customerPrice - the customerPrice to set
  - getCustomerText
```
java.lang.String getCustomerText()
```
    Only applicable in the case where the option is of type TYPE_CUSTOMER_TEXT. In this case the customer may define text to customize the product.
    
    Returns:
    
    the customerText
  - setCustomerText
```
void setCustomerText(java.lang.String customerText)
```
    Only applicable in the case where the option is of type TYPE_CUSTOMER_TEXT. In this case the customer may define text to customize the product.
    
    Parameters:
    
    customerText - the customerText to set
  - getSortOrder
```
int getSortOrder()
```
    Determines the sort order of the options
    
    Returns:
    
    the sortOrder
  - setSortOrder
```
void setSortOrder(int sortOrder)
```
    Determines the sort order of the options
    
    Parameters:
    
    sortOrder - the sortOrder to set
  - getExtPrice0
```
java.math.BigDecimal getExtPrice0()
```
    Returns:
    
    the extPrice0
  - setExtPrice0
```
void setExtPrice0(java.math.BigDecimal extPrice0)
```
    Parameters:
    
    extPrice0 - the extPrice0 to set
  - getExtPrice1
```
java.math.BigDecimal getExtPrice1()
```
    Returns:
    
    the extPrice1
  - setExtPrice1
```
void setExtPrice1(java.math.BigDecimal extPrice1)
```
    Parameters:
    
    extPrice1 - the extPrice1 to set
  - getExtPrice2
```
java.math.BigDecimal getExtPrice2()
```
    Returns:
    
    the extPrice2
  - setExtPrice2
```
void setExtPrice2(java.math.BigDecimal extPrice2)
```
    Parameters:
    
    extPrice2 - the extPrice2 to set
  - getExtPrice3
```
java.math.BigDecimal getExtPrice3()
```
    Returns:
    
    the extPrice3
  - setExtPrice3
```
void setExtPrice3(java.math.BigDecimal extPrice3)
```
    Parameters:
    
    extPrice3 - the extPrice3 to set

Interface OptionIf

Method Summary

Method Detail

getName

setName

getCode

setCode

getValue

setValue

getValueCode

setValueCode

getValueId

setValueId

getId

setId

getAttrId

setAttrId

getPriceExTax

setPriceExTax

getPriceIncTax

setPriceIncTax

getPrice0

setPrice0

getPrice1

setPrice1

getPrice2

setPrice2

getPrice3

setPrice3

getAttrCustom1

setAttrCustom1

getAttrCustom2

setAttrCustom2

getOptionCustom1

setOptionCustom1

getOptionCustom2

setOptionCustom2

getOptionValCustom1

setOptionValCustom1

getOptionValCustom2

setOptionValCustom2

getType

setType

getQuantity

setQuantity

getCustomerPrice

setCustomerPrice

getCustomerText

setCustomerText

getSortOrder

setSortOrder

getExtPrice0

setExtPrice0

getExtPrice1

setExtPrice1

getExtPrice2

setExtPrice2

getExtPrice3

setExtPrice3