ProductFormatter (posper 3.0 API)

java.lang.Object
- org.posper.hibernate.formatters.ProductFormatter

```
public class ProductFormatter
extends Object
```
ProductFormatter is used to get access to product information from velocity templates.

Author:

hstadler

Constructor Summary

Constructors
Constructor and Description

ProductFormatter(Product product)
Create a ProductFormatter object

Constructors
Constructor and Description
`ProductFormatter(Product product)` Create a ProductFormatter object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCategory()` Get the product category
`String`	`getCode()` Get the barcode
`Boolean`	`getInStock()` Return a the inStock value as a Boolean
`String`	`getName()` Get the product name
`Double`	`getPriceBuy()` Get the buy price
`Double`	`getPriceBuyTax()` Get the buy price with tax
`Double`	`getPriceSell()` Get the sell price
`Double`	`getPriceSellTax()` Get the sell price with tax
`String`	`getReference()` Get the reference number
`Double`	`getTaxRate()` Get the tax rate.
`Double`	`getUnits()` Get the number of units
`String`	`getUnitType()` Get the unit type
`boolean`	`isProductCom()` Identify helper products (commissioning products)
`String`	`printInStock()` Return the inStock value as string
`String`	`printPriceBuy()` Get the buy price
`String`	`printPriceBuyTax()` Get the buy price with tax
`String`	`printPriceSell()` Get the sell price
`String`	`printPriceSellTax()` Get the sell price with tax
`String`	`printsPriceBuy()` Get the buy price
`String`	`printsPriceBuyTax()` Get the buy price with tax
`String`	`printsPriceSell()` Get the sell price
`String`	`printsPriceSellTax()` Get the sell price with tax
`String`	`printTaxRate()` Get the tax rate.

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

- Constructor Detail
  - ProductFormatter
```
public ProductFormatter(Product product)
```
    Create a ProductFormatter object
    
    Parameters:
    
    product -
- Method Detail
  - getName
```
public String getName()
```
    Get the product name
    
    Returns:
    
    a string with the product name
  - getPriceBuy
```
public Double getPriceBuy()
```
    Get the buy price
    
    Returns:
    
    buy price as double
  - printPriceBuy
```
public String printPriceBuy()
```
    Get the buy price
    
    Returns:
    
    a currency formatted string
  - printsPriceBuy
```
public String printsPriceBuy()
```
    Get the buy price
    
    Returns:
    
    a 2 decimals formatted string
  - getPriceBuyTax
```
public Double getPriceBuyTax()
```
    Get the buy price with tax
    
    Returns:
    
    buy price with tax as double
  - printPriceBuyTax
```
public String printPriceBuyTax()
```
    Get the buy price with tax
    
    Returns:
    
    a currency formatted string
  - printsPriceBuyTax
```
public String printsPriceBuyTax()
```
    Get the buy price with tax
    
    Returns:
    
    a 2 decimals formatted string
  - getPriceSell
```
public Double getPriceSell()
```
    Get the sell price
    
    Returns:
    
    sell price as double
  - printPriceSell
```
public String printPriceSell()
```
    Get the sell price
    
    Returns:
    
    a currency formatted string
  - printsPriceSell
```
public String printsPriceSell()
```
    Get the sell price
    
    Returns:
    
    a 2 decimals formatted string
  - getPriceSellTax
```
public Double getPriceSellTax()
```
    Get the sell price with tax
    
    Returns:
    
    sell price with tax as double
  - printPriceSellTax
```
public String printPriceSellTax()
```
    Get the sell price with tax
    
    Returns:
    
    a currency formatted string
  - printsPriceSellTax
```
public String printsPriceSellTax()
```
    Get the sell price with tax
    
    Returns:
    
    a 2 decimals formatted string
  - getCategory
```
public String getCategory()
```
    Get the product category
    
    Returns:
    
    a string with the product category
  - getCode
```
public String getCode()
```
    Get the barcode
    
    Returns:
    
    a string with the barcode
  - getReference
```
public String getReference()
```
    Get the reference number
    
    Returns:
    
    a string with the reference number
  - isProductCom
```
public boolean isProductCom()
```
    Identify helper products (commissioning products)
    
    Returns:
    
    true if the item is a helper product
  - getTaxRate
```
public Double getTaxRate()
```
    Get the tax rate.
    
    Returns:
    
    the tax rate as Double
  - printTaxRate
```
public String printTaxRate()
```
    Get the tax rate.
    
    Returns:
    
    a percent formatted string with the tax rate
  - printInStock
```
public String printInStock()
```
    Return the inStock value as string
    
    Returns:
    
    a localized String yes/no for the inStock value
  - getInStock
```
public Boolean getInStock()
```
    Return a the inStock value as a Boolean
    
    Returns:
    
    true if the product is in stock
  - getUnits
```
public Double getUnits()
```
    Get the number of units
    
    Returns:
    
    units as Double
  - getUnitType
```
public String getUnitType()
```
    Get the unit type
    
    Returns:
    
    unitType as String

Class ProductFormatter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProductFormatter

Method Detail

getName

getPriceBuy

printPriceBuy

printsPriceBuy

getPriceBuyTax

printPriceBuyTax

printsPriceBuyTax

getPriceSell

printPriceSell

printsPriceSell

getPriceSellTax

printPriceSellTax

printsPriceSellTax

getCategory

getCode

getReference

isProductCom

getTaxRate

printTaxRate

printInStock

getInStock

getUnits

getUnitType