AdminOption (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminOption

public class AdminOption
extends java.lang.Object

Option object for the Admin App

Field Summary

Fields
Modifier and Type	Field and Description
`private java.math.BigDecimal`	`customerPrice` customerPrice
`private java.lang.String`	`customerText` customerText
`private int`	`id` id
`private java.lang.String`	`name` name
`private java.math.BigDecimal`	`priceExTax` priceExTax
`private java.math.BigDecimal`	`priceIncTax` priceIncTax
`private int`	`quantity` quantity
`private int`	`type` type of option
`static int`	`TYPE_CUSTOMER_PRICE` Constant to define the Option type.
`static int`	`TYPE_CUSTOMER_TEXT` Constant to define the Option type.
`static int`	`TYPE_SIMPLE` Constant to define the Option type
`static int`	`TYPE_VARIABLE_QUANTITY` Constant to define the Option type.
`private java.lang.String`	`value` value
`private int`	`valueId` id

Constructor Summary

Constructors
Constructor and Description

AdminOption()
Constructor

AdminOption(com.workingdogs.village.Record vr, com.konakart.db.KKCriteria c)

Constructors
Constructor and Description
`AdminOption()` Constructor
`AdminOption(com.workingdogs.village.Record vr, com.konakart.db.KKCriteria c)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`int`	`getId()`
`java.lang.String`	`getName()`
`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`	`getType()` The type of option.
`java.lang.String`	`getValue()`
`int`	`getValueId()`
`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`	`setId(int id)`
`void`	`setName(java.lang.String name)`
`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`	`setType(int type)` The type of option.
`void`	`setValue(java.lang.String value)`
`void`	`setValueId(int valueId)`
`java.lang.String`	`toString()`

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

- Field Detail
  - TYPE_SIMPLE
```
public static final int TYPE_SIMPLE
```
    Constant to define the Option type
    
    See Also:
    
    Constant Field Values
  - TYPE_VARIABLE_QUANTITY
```
public static final int TYPE_VARIABLE_QUANTITY
```
    Constant to define the Option type. In this case a quantity may be defined for the option. (i.e. Number of megabytes)
    
    See Also:
    
    Constant Field Values
  - TYPE_CUSTOMER_PRICE
```
public static final int TYPE_CUSTOMER_PRICE
```
    Constant to define the Option type. A customer may enter the price for the option.
    
    See Also:
    
    Constant Field Values
  - TYPE_CUSTOMER_TEXT
```
public static final int TYPE_CUSTOMER_TEXT
```
    Constant to define the Option type. A customer may enter some text for the option.
    
    See Also:
    
    Constant Field Values
  - id
```
private int id
```
    id
  - valueId
```
private int valueId
```
    id
  - name
```
private java.lang.String name
```
    name
  - value
```
private java.lang.String value
```
    value
  - type
```
private int type
```
    type of option
  - quantity
```
private int quantity
```
    quantity
  - customerPrice
```
private java.math.BigDecimal customerPrice
```
    customerPrice
  - customerText
```
private java.lang.String customerText
```
    customerText
  - priceIncTax
```
private java.math.BigDecimal priceIncTax
```
    priceIncTax
  - priceExTax
```
private java.math.BigDecimal priceExTax
```
    priceExTax
- Constructor Detail
  - AdminOption
```
public AdminOption()
```
    Constructor
  - AdminOption
```
public AdminOption(com.workingdogs.village.Record vr,
                   com.konakart.db.KKCriteria c)
            throws com.workingdogs.village.DataSetException
```
    Parameters:
    
    vr - the vr
    
    c - the c
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the Option object.
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    Returns the name.
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - The name to set.
  - getValue
```
public java.lang.String getValue()
```
    Returns:
    
    Returns the value.
  - setValue
```
public void setValue(java.lang.String value)
```
    Parameters:
    
    value - The value to set.
  - getValueId
```
public int getValueId()
```
    Returns:
    
    Returns the valueId.
  - setValueId
```
public void setValueId(int valueId)
```
    Parameters:
    
    valueId - The valueId to set.
  - getId
```
public int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getPriceExTax
```
public java.math.BigDecimal getPriceExTax()
```
    Returns:
    
    Returns the priceExTax.
  - setPriceExTax
```
public void setPriceExTax(java.math.BigDecimal priceExTax)
```
    Parameters:
    
    priceExTax - The priceExTax to set.
  - getPriceIncTax
```
public java.math.BigDecimal getPriceIncTax()
```
    Returns:
    
    Returns the priceIncTax.
  - setPriceIncTax
```
public void setPriceIncTax(java.math.BigDecimal priceIncTax)
```
    Parameters:
    
    priceIncTax - The priceIncTax to set.
  - getType
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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
```
public 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

Class AdminOption

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_SIMPLE

TYPE_VARIABLE_QUANTITY

TYPE_CUSTOMER_PRICE

TYPE_CUSTOMER_TEXT

id

valueId

name

value

type

quantity

customerPrice

customerText

priceIncTax

priceExTax

Constructor Detail

AdminOption

AdminOption

Method Detail

toString

getName

setName

getValue

setValue

getValueId

setValueId

getId

setId

getPriceExTax

setPriceExTax

getPriceIncTax

setPriceIncTax

getType

setType

getQuantity

setQuantity

getCustomerPrice

setCustomerPrice

getCustomerText

setCustomerText