Product (posper 3.0 API)

java.lang.Object
- org.posper.hibernate.AbstractHibernateObject<Type>
- - org.posper.hibernate.AbstractIdentifiedHibernateObject<Product>
  - - org.posper.hibernate.Product

All Implemented Interfaces:

Serializable, Auditable, IItem
```
public class Product
extends AbstractIdentifiedHibernateObject<Product>
implements IItem, Auditable
```
Changes: - modifiers - accountingLevel

Author:

Hans, Aaron Luchko , Carlos Camacho

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCOUNTINGLEVEL_CASHOUT`
`static int`	`ACCOUNTINGLEVEL_TOGO`
`static int`	`ACCOUNTINGLEVEL_TOPUP`
`static Short`	`PREP_TIME_DONT_SHOW_`
`static Short`	`PREP_TIME_FROM_CATEGORY`

Fields inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject
id

Constructor Summary

Constructors
Constructor and Description
`Product()`
`Product(Double priceSell, Tax tax)` Create a dummy product for use with Dialog6.
`Product(String id, String reference, String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`doCategoriesFromArray(Object[] categories)`
`void`	`doTaxesFromArray(Object[] taxes)`
`static List<Product>`	`findProductByID(String id, org.hibernate.Session sess)` Find a product by the product id
`int`	`getAccountingLevel()` Used to assign a product to one or more categories for statistical accounting purposes.
`int`	`getActMod()` Get the bitmask indicating which modifiers are acrive for this product: bit = 0 bit means inactive, bit = 1 means active!
`Set<Category>`	`getCategories()`
`Category`	`getCategory()`
`String`	`getCode()`
`Byte`	`getCourse()`
`Date`	`getCreated_at()`
`Integer`	`getDisplayOrder()`
`Set<ProductEan>`	`getEan()`
`Image`	`getImage()`
`Product`	`getItem()`
`String`	`getLongDescription()`
`int`	`getModifiers()` Get the bitmask indicating which modifiers are permitted for this product: bit = 0 bit means allow, bit = 1 means deny!
`String`	`getName()`
`Short`	`getPrep_time()` Get the preparation time for this products.
`Double`	`getPriceBase()`
`Double`	`getPriceBuy()`
`Double`	`getPriceSell_1()` Get an alternative selling price 1.
`Double`	`getPriceSell_2()` Get an alternative selling price 2.
`Double`	`getPriceSell()`
`Set<ProductLocation>`	`getProductLocations()`
`String`	`getReference()`
`Date`	`getRepl_avail_date()`
`String`	`getRepl_code()`
`Date`	`getRepl_date()`
`Product`	`getReplacement()`
`Double`	`getStockCost()`
`Tare`	`getTare()`
`Tax`	`getTax()`
`Set<Tax>`	`getTaxes()`
`Date`	`getTimed_availability_to()`
`Double`	`getUnits()`
`String`	`getUnitType()`
`Date`	`getUpdated_at()`
`Double`	`getVolume()`
`Boolean`	`isCom()`
`Boolean`	`isInStock()` Whether the product is available to be bought/sold.
`Boolean`	`isScale()`
`String`	`printPriceSell()`
`String`	`printPriceSellTax()`
`Double`	`retrieveCombinedTaxRate()`
`void`	`setAccountingLevel(int accountingLevel)`
`void`	`setActMod(int actMod)` Set the bitmask indicating which modifiers are acrive for this product: bit = 0 bit means inactive, bit = 1 means active!
`void`	`setCategories(Set<Category> categories)`
`void`	`setCategory(Category category)`
`void`	`setCode(String code)`
`void`	`setCom(Boolean com)`
`void`	`setCourse(Byte course)`
`void`	`setCreated_at(Date created_at)`
`void`	`setDisplayOrder(Integer displayOrder)` Sets the position this product will be displayed in within its category
`void`	`setEan(Set<ProductEan> ean)`
`void`	`setImage(Image image)`
`void`	`setInStock(Boolean inStock)` Whether the product is available to be bought/sold.
`void`	`setLongDescription(String longDescription)`
`void`	`setModifiers(int modifiers)` Set the bitmask indicating which modifiers are permitted for this product: bit = 0 bit means allow, bit = 1 means deny!
`void`	`setName(String name)`
`void`	`setPrep_time(Short prep_time)` Get the preparation time for this products.
`void`	`setPriceBase(Double priceBase)`
`void`	`setPriceBuy(Double priceBuy)`
`void`	`setPriceSell_1(Double priceSell_1)` Set an alternative selling price
`void`	`setPriceSell_2(Double priceSell_2)` Set an alternative selling price
`void`	`setPriceSell(Double priceSell)`
`void`	`setProductLocations(Set<ProductLocation> productLocations)`
`void`	`setReference(String reference)`
`void`	`setRepl_avail_date(Date repl_avail_date)`
`void`	`setRepl_code(String repl_code)`
`void`	`setRepl_date(Date repl_date)`
`void`	`setScale(Boolean scale)`
`void`	`setStockCost(Double stockCost)`
`void`	`setTare(Tare tare)`
`void`	`setTax(Tax tax)`
`void`	`setTaxes(Set<Tax> taxes)`
`void`	`setTimed_availability_to(Date timed_availability_to)`
`void`	`setUnits(Double units)`
`void`	`setUnitType(String unitType)`
`void`	`setUpdated_at(Date updated_at)`
`void`	`setVolume(Double Volume)`

Methods inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject
equals, getId, getVersion, hashCode, setId, setVersion

Methods inherited from class org.posper.hibernate.AbstractHibernateObject
delete, getGetters, getKeyValue, merge, refresh, save

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

Methods inherited from interface org.posper.hibernate.IItem
getId

Field Detail

PREP_TIME_DONT_SHOW_

public static final Short PREP_TIME_DONT_SHOW_

PREP_TIME_FROM_CATEGORY

public static final Short PREP_TIME_FROM_CATEGORY

ACCOUNTINGLEVEL_TOGO

public static final int ACCOUNTINGLEVEL_TOGO

ACCOUNTINGLEVEL_TOPUP

public static final int ACCOUNTINGLEVEL_TOPUP

ACCOUNTINGLEVEL_CASHOUT

public static final int ACCOUNTINGLEVEL_CASHOUT

Constructor Detail

Product
```
public Product()
```

Product

public Product(String id,
               String reference,
               String name)

Product
```
public Product(Double priceSell,
               Tax tax)
```
Create a dummy product for use with Dialog6. This object must never be persisted.

Parameters:

priceSell -

tax -

Method Detail

getItem
```
public Product getItem()
```
Specified by:

getItem in interface IItem

setCreated_at
```
public void setCreated_at(Date created_at)
```
Specified by:

setCreated_at in interface Auditable

setUpdated_at
```
public void setUpdated_at(Date updated_at)
```
Specified by:

setUpdated_at in interface Auditable

getCreated_at
```
public Date getCreated_at()
```

getUpdated_at
```
public Date getUpdated_at()
```

getName
```
public String getName()
```
Specified by:

getName in interface IItem

setName

public void setName(String name)
             throws BasicException

Throws:: BasicException

getImage
```
public Image getImage()
```
Specified by:

getImage in interface IItem

getCode
```
public String getCode()
```

setCode
```
public void setCode(String code)
```

isCom
```
public Boolean isCom()
```

setCom
```
public void setCom(Boolean com)
```

isScale
```
public Boolean isScale()
```

setScale
```
public void setScale(Boolean scale)
```

getPriceBase
```
public Double getPriceBase()
```

setPriceBase

public void setPriceBase(Double priceBase)

getCategory
```
public Category getCategory()
```

setCategory

public void setCategory(Category category)

getCategories
```
public Set<Category> getCategories()
```

setCategories

public void setCategories(Set<Category> categories)

getTaxes
```
public Set<Tax> getTaxes()
```

getTax
```
public Tax getTax()
```

retrieveCombinedTaxRate

public Double retrieveCombinedTaxRate()

setTax
```
public void setTax(Tax tax)
```

setTaxes
```
public void setTaxes(Set<Tax> taxes)
```

doTaxesFromArray

public void doTaxesFromArray(Object[] taxes)

doCategoriesFromArray

public void doCategoriesFromArray(Object[] categories)

getPriceBuy
```
public Double getPriceBuy()
```

setPriceBuy

public void setPriceBuy(Double priceBuy)

getPriceSell
```
public Double getPriceSell()
```

setPriceSell

public void setPriceSell(Double priceSell)

getPriceSell_1
```
public Double getPriceSell_1()
```
Get an alternative selling price 1. Use a modifier function to access this price instead of priceSell.

Returns:

an alzternative selling price

setPriceSell_1
```
public void setPriceSell_1(Double priceSell_1)
```
Set an alternative selling price

Parameters:

priceSell_1 -

getPriceSell_2
```
public Double getPriceSell_2()
```
Get an alternative selling price 2. Use a modifier function to access this price instead of priceSell.

Returns:

an alzternative selling price

setPriceSell_2
```
public void setPriceSell_2(Double priceSell_2)
```
Set an alternative selling price

Parameters:

priceSell_1 -

getStockCost
```
public Double getStockCost()
```

setStockCost

public void setStockCost(Double stockCost)

getVolume
```
public Double getVolume()
```

setVolume
```
public void setVolume(Double Volume)
```

setImage
```
public void setImage(Image image)
```

findProductByID

public static List<Product> findProductByID(String id,
                                            org.hibernate.Session sess)

Find a product by the product id

Parameters:: id -; sess - A valid Hibernate session
Returns:

getDisplayOrder
```
public Integer getDisplayOrder()
```
Returns:

the displayOrder

setDisplayOrder
```
public void setDisplayOrder(Integer displayOrder)
```
Sets the position this product will be displayed in within its category

Parameters:

displayOrder - the displayOrder to set

isInStock
```
public Boolean isInStock()
```
Whether the product is available to be bought/sold.

Returns:

the inStock

setInStock
```
public void setInStock(Boolean inStock)
```
Whether the product is available to be bought/sold.

Parameters:

inStock - true if is available

getProductLocations

public Set<ProductLocation> getProductLocations()

setProductLocations

public void setProductLocations(Set<ProductLocation> productLocations)

printPriceSellTax
```
public String printPriceSellTax()
```
Returns:

the sell price with tax formatted as currency

printPriceSell
```
public String printPriceSell()
```
Returns:

the sell price formatted as currency

getReference
```
public String getReference()
```
Returns:

the reference

setReference
```
public void setReference(String reference)
```
Parameters:

reference - the reference to set

getModifiers
```
public int getModifiers()
```
Get the bitmask indicating which modifiers are permitted for this product: bit = 0 bit means allow, bit = 1 means deny!

Returns:

the modifier mask

setModifiers
```
public void setModifiers(int modifiers)
```
Set the bitmask indicating which modifiers are permitted for this product: bit = 0 bit means allow, bit = 1 means deny!

getActMod
```
public int getActMod()
```
Get the bitmask indicating which modifiers are acrive for this product: bit = 0 bit means inactive, bit = 1 means active!

Returns:

the modifier mask

setActMod
```
public void setActMod(int actMod)
```
Set the bitmask indicating which modifiers are acrive for this product: bit = 0 bit means inactive, bit = 1 means active!

getAccountingLevel
```
public int getAccountingLevel()
```
Used to assign a product to one or more categories for statistical accounting purposes. The accounting levels (=categories) should be represented by single bits.

Returns:

the accounting level

setAccountingLevel

public void setAccountingLevel(int accountingLevel)

getUnitType
```
public String getUnitType()
```

getUnits
```
public Double getUnits()
```

setUnitType

public void setUnitType(String unitType)

setUnits
```
public void setUnits(Double units)
```

getEan
```
public Set<ProductEan> getEan()
```

setEan

public void setEan(Set<ProductEan> ean)

getTare
```
public Tare getTare()
```

setTare
```
public void setTare(Tare tare)
```

getPrep_time
```
public Short getPrep_time()
```
Get the preparation time for this products.

Returns:

the preparation time for this products.

setPrep_time
```
public void setPrep_time(Short prep_time)
```
Get the preparation time for this products. (see Products.getPrep_time).

Parameters:

prep_time - the preparation time for this products.

getCourse
```
public Byte getCourse()
```

setCourse
```
public void setCourse(Byte course)
```

getRepl_avail_date
```
public Date getRepl_avail_date()
```

setRepl_avail_date

public void setRepl_avail_date(Date repl_avail_date)

getRepl_code
```
public String getRepl_code()
```

setRepl_code

public void setRepl_code(String repl_code)

getRepl_date
```
public Date getRepl_date()
```

setRepl_date

public void setRepl_date(Date repl_date)

getTimed_availability_to

public Date getTimed_availability_to()

setTimed_availability_to

public void setTimed_availability_to(Date timed_availability_to)

getReplacement
```
public Product getReplacement()
```

setLongDescription

public void setLongDescription(String longDescription)

getLongDescription
```
public String getLongDescription()
```

Class Product

Field Summary

Fields inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject

Constructor Summary

Method Summary

Methods inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject

Methods inherited from class org.posper.hibernate.AbstractHibernateObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.posper.hibernate.IItem

Field Detail

PREP_TIME_DONT_SHOW_

PREP_TIME_FROM_CATEGORY

ACCOUNTINGLEVEL_TOGO

ACCOUNTINGLEVEL_TOPUP

ACCOUNTINGLEVEL_CASHOUT

Constructor Detail

Product

Product

Product

Method Detail

getItem

setCreated_at

setUpdated_at

getCreated_at

getUpdated_at

getName

setName

getImage

getCode

setCode

isCom

setCom

isScale

setScale

getPriceBase

setPriceBase

getCategory

setCategory

getCategories

setCategories

getTaxes

getTax

retrieveCombinedTaxRate

setTax

setTaxes

doTaxesFromArray

doCategoriesFromArray

getPriceBuy

setPriceBuy

getPriceSell

setPriceSell

getPriceSell_1

setPriceSell_1

getPriceSell_2

setPriceSell_2

getStockCost

setStockCost

getVolume

setVolume

setImage

findProductByID

getDisplayOrder

setDisplayOrder

isInStock

setInStock

getProductLocations

setProductLocations

printPriceSellTax

printPriceSell

getReference

setReference

getModifiers

setModifiers

getActMod

setActMod

getAccountingLevel

setAccountingLevel

getUnitType

getUnits

setUnitType