TicketLine (posper 3.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<TicketLine>, Auditable
```
public class TicketLine
extends AbstractIdentifiedHibernateObject<TicketLine>
implements Cloneable, Comparable<TicketLine>, Auditable
```
A Ticket Line holds information regarding a ticket including the product being sold, the amount and cost of what's being sold, and associated taxes. Changes:
- rounding for calculateTotal() and calculateSubTotal()
- clone: version set to zero

Author:

Hans, manuelnaranjo, Aaron Luchko , Jamie Campbell

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`STATUS_CREATED`
`static byte`	`STATUS_LOCKED`
`static byte`	`STATUS_ORDERED`
`static byte`	`STATUS_OUT`
`static byte`	`STATUS_PREPARING`
`static byte`	`STATUS_SELECTED`
`static byte`	`STATUS_SERVING`

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TicketLine()` Creates a new instance of TicketLine
	`TicketLine(Product product, double multiply, double priceSell)`
	`TicketLine(Tax t, double multiply, double priceSell)`
	`TicketLine(TicketLine line)` Creates a new instance of TicketLine - only selected properties of line are copied.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignTax(Tax tax)` This is used to set the products taxes to only one tax
`void`	`assignTaxes(Set<Tax> taxes)` A convenience method that sets both the tax and taxRate at once
`double`	`calculateSubTotal()` Net value of the line, rounded to the locally required precision.
`double`	`calculateTotal()` Gross value of the line, rounded to the locally required predision)
`double`	`calculateTotalOrig()`
`TicketLine`	`clone()`
`int`	`compareTo(TicketLine cline)`
`Double`	`getAmount()`
`String`	`getComment()`
`String`	`getComProducts()`
`User`	`getCook()`
`Byte`	`getCourse()`
`Date`	`getCreated_at()`
`String`	`getDescription()` This column describes the purpose of the line, in the case of selling a product it's just the product's name but otherwise it becomes an optional description of the reason for a charge.
`DiscountReason`	`getDiscountReason()` If this ticketline was discounted than this will specify the reason why.
`Integer`	`getModifiers()` This column holds the modifier mask (ha)
`double`	`getOldAmount()`
`double`	`getOrderPrinted()` Retrieve the number of items with which the line has been printed to a kitchen order receipt.
`Ticket`	`getParent()`
`Double`	`getPriceBuy()` This transient property is used to allow a modifier to set a buy price different from the one in the Product.
`Double`	`getPriceOrig()`
`Double`	`getPriceSell()`
`Product`	`getProduct()`
`Boolean`	`getProtect()`
`Reservation`	`getReservation()`
`Boolean`	`getReserved()`
`Integer`	`getSeat()` Get the seat number as Byte The number of seats available can be limited through a custom variable.
`Byte`	`getStatus()` The status is primarily used to indicate the line status for the kitchen monitor
`Integer`	`getTare()` The tare value is only stored for scale products.
`Tax`	`getTax()`
`Set<Tax>`	`getTaxes()`
`Double`	`getTaxRate()`
`int`	`getTotal_amount()`
`Date`	`getUpdated_at()`
`boolean`	`hasAccountingLevels(int levelMask)` Returns true if at least one of the accounting levels in mask is set for the product assigned to the line.
`boolean`	`hasReservation()` Convenience method to get the RESERVED status
`Boolean`	`isComProduct()`
`Boolean`	`isCoupon()`
`Boolean`	`isInactiveVoucher()`
`boolean`	`isProductCom()`
`boolean`	`lineIsPrinted()` Boolean value to determine if the line has been printed to a kitchen order receipt.
`void`	`lineIsPrinted(boolean orderPrinted)` Set a boolean value to determine if the line has been printed to a kitchen order receipt.
`String`	`printCategoryName()` Print the category name of the associated product.
`String`	`printPlace()` Used for audit: get the name of the parent tickets place, if any.
`void`	`save()` This is a convenience method to wrap the operation in a transaction.
`void`	`setAmount(Double amount)`
`void`	`setComment(String comment)`
`void`	`setComProduct(Boolean comProduct)`
`void`	`setComProducts(String comProducts)`
`void`	`setCook(User cook)`
`void`	`setCoupon(Boolean coupon)`
`void`	`setCourse(Byte course)`
`void`	`setCreated_at(Date created_at)`
`void`	`setDescription(String description)`
`void`	`setDiscountReason(DiscountReason discountReason)`
`void`	`setInactiveVoucher(Boolean isInactive)`
`void`	`setModifiers(Integer modifiers)` Set the modifier mask for the ticket line.
`void`	`setOldAmount(double oldAmount)`
`void`	`setOrderPrinted(double amount)` Set an amount to determine for how many items the line has been printed to a kitchen order receipt.
`void`	`setParent(Ticket parent)` Note that this relationship is controlled by Ticket so this method isn't particularly useful from a persistence context.
`void`	`setPriceBuy(Double priceBuy)`
`void`	`setPriceOrig(Double priceOrig)`
`void`	`setPriceSell(Double sellPrice)`
`void`	`setProduct(Product product)`
`void`	`setProtect(Boolean protect)`
`void`	`setReservation(Reservation reservation)`
`void`	`setReserved(Boolean reserved)`
`void`	`setSeat(Integer seat)`
`void`	`setStatus(Byte status)`
`void`	`setTare(Integer tare)`
`void`	`setTax(Tax tax)`
`void`	`setTaxes(Set<Tax> taxes)`
`void`	`setTaxRate(double taxRate)`
`void`	`setTotal_amount(int total_amount)`
`void`	`setUpdated_at(Date updated_at)`
`void`	`updateReservation()` The cloning process for reservations does not set the resource_id properly.

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

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

- Field Detail
  - STATUS_CREATED
```
public static final byte STATUS_CREATED
```
    See Also:
    
    Constant Field Values
  - STATUS_ORDERED
```
public static final byte STATUS_ORDERED
```
    See Also:
    
    Constant Field Values
  - STATUS_PREPARING
```
public static final byte STATUS_PREPARING
```
    See Also:
    
    Constant Field Values
  - STATUS_SERVING
```
public static final byte STATUS_SERVING
```
    See Also:
    
    Constant Field Values
  - STATUS_OUT
```
public static final byte STATUS_OUT
```
    See Also:
    
    Constant Field Values
  - STATUS_LOCKED
```
public static final byte STATUS_LOCKED
```
    See Also:
    
    Constant Field Values
  - STATUS_SELECTED
```
public static final byte STATUS_SELECTED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TicketLine
```
protected TicketLine()
```
    Creates a new instance of TicketLine
  - TicketLine
```
public TicketLine(TicketLine line)
```
    Creates a new instance of TicketLine - only selected properties of line are copied. This condtructor is only used for reference objects when editing a line
    
    Parameters:
    
    line - properties of line will be copied
  - TicketLine
```
public TicketLine(Product product,
                  double multiply,
                  double priceSell)
```
  - TicketLine
```
public TicketLine(Tax t,
                  double multiply,
                  double priceSell)
```
- Method Detail
  - getReservation
```
public Reservation getReservation()
```
  - setReservation
```
public void setReservation(Reservation reservation)
```
  - getProduct
```
public Product getProduct()
```
  - setProduct
```
public void setProduct(Product product)
```
  - isProductCom
```
public boolean isProductCom()
```
  - getDescription
```
public String getDescription()
```
    This column describes the purpose of the line, in the case of selling a product it's just the product's name but otherwise it becomes an optional description of the reason for a charge.
    
    Returns:
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description - the description to set
  - assignTaxes
```
public void assignTaxes(Set<Tax> taxes)
```
    A convenience method that sets both the tax and taxRate at once
    
    Parameters:
    
    taxes -
  - assignTax
```
public void assignTax(Tax tax)
```
    This is used to set the products taxes to only one tax
    
    Parameters:
    
    tax -
  - getAmount
```
public Double getAmount()
```
  - setAmount
```
public void setAmount(Double amount)
```
  - getParent
```
public Ticket getParent()
```
  - setParent
```
public void setParent(Ticket parent)
```
    Note that this relationship is controlled by Ticket so this method isn't particularly useful from a persistence context.
    
    Parameters:
    
    parent -
  - getPriceSell
```
public Double getPriceSell()
```
  - setPriceSell
```
public void setPriceSell(Double sellPrice)
```
  - getPriceBuy
```
public Double getPriceBuy()
```
    This transient property is used to allow a modifier to set a buy price different from the one in the Product.
    
    Returns:
  - setPriceBuy
```
public void setPriceBuy(Double priceBuy)
```
  - getTaxRate
```
public Double getTaxRate()
```
  - setTaxRate
```
public void setTaxRate(double taxRate)
```
  - getReserved
```
public Boolean getReserved()
```
  - setReserved
```
public void setReserved(Boolean reserved)
```
  - getProtect
```
public Boolean getProtect()
```
  - setProtect
```
public void setProtect(Boolean protect)
```
  - calculateTotal
```
public double calculateTotal()
```
    Gross value of the line, rounded to the locally required predision)
    
    Returns:
    
    rounden gross value
  - calculateTotalOrig
```
public double calculateTotalOrig()
```
  - calculateSubTotal
```
public double calculateSubTotal()
```
    Net value of the line, rounded to the locally required precision. Since tax values should be based on the net values we need a procedure to calculate the net value based on the correct tax amount to avoid rounding problemd
    
    Returns:
  - clone
```
public TicketLine clone()
                 throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getTax
```
public Tax getTax()
```
  - getTaxes
```
public Set<Tax> getTaxes()
```
  - setTax
```
public void setTax(Tax tax)
```
  - setTaxes
```
public final void setTaxes(Set<Tax> taxes)
```
  - getDiscountReason
```
public DiscountReason getDiscountReason()
```
    If this ticketline was discounted than this will specify the reason why.
    
    Returns:
    
    the discountReason
  - setDiscountReason
```
public void setDiscountReason(DiscountReason discountReason)
```
    Parameters:
    
    discountReason - the discountReason to set
  - getModifiers
```
public Integer getModifiers()
```
    This column holds the modifier mask (ha)
    
    Returns:
  - setModifiers
```
public void setModifiers(Integer modifiers)
```
    Set the modifier mask for the ticket line. If the auditModifiers option is true a log entry is written if a modifier has changed and the item has been marked as ordered unless the modifier is in the auditModifiersExclude mask.
    
    Parameters:
    
    modifiers -
  - getCook
```
public User getCook()
```
  - setCook
```
public void setCook(User cook)
```
  - getCourse
```
public Byte getCourse()
```
  - setCourse
```
public void setCourse(Byte course)
```
  - getCreated_at
```
public Date getCreated_at()
```
  - setCreated_at
```
public void setCreated_at(Date created_at)
```
    Specified by:
    
    setCreated_at in interface Auditable
  - getStatus
```
public Byte getStatus()
```
    The status is primarily used to indicate the line status for the kitchen monitor
    
    Returns:
    
    the status byte.
  - setStatus
```
public void setStatus(Byte status)
```
  - isInactiveVoucher
```
public Boolean isInactiveVoucher()
```
  - setInactiveVoucher
```
public void setInactiveVoucher(Boolean isInactive)
```
  - isCoupon
```
public Boolean isCoupon()
```
  - setCoupon
```
public void setCoupon(Boolean coupon)
```
  - isComProduct
```
public Boolean isComProduct()
```
  - setComProduct
```
public void setComProduct(Boolean comProduct)
```
  - getUpdated_at
```
public Date getUpdated_at()
```
  - setUpdated_at
```
public void setUpdated_at(Date updated_at)
```
    Specified by:
    
    setUpdated_at in interface Auditable
  - lineIsPrinted
```
public boolean lineIsPrinted()
```
    Boolean value to determine if the line has been printed to a kitchen order receipt. Used via TicketlineFormatter#getOrderPrinted()
    
    Returns:
    
    boolean print state
  - getOrderPrinted
```
public double getOrderPrinted()
```
    Retrieve the number of items with which the line has been printed to a kitchen order receipt. Used via TicketlineFormatter#getItemsPrinted().
    
    Returns:
    
    double printed amount of items
  - lineIsPrinted
```
public void lineIsPrinted(boolean orderPrinted)
```
    Set a boolean value to determine if the line has been printed to a kitchen order receipt. Used via TicketlineFormatter#setOrderPrinted().
    
    Parameters:
    
    orderPrinted - set to true when printing the line.
  - getComment
```
public String getComment()
```
  - setComment
```
public void setComment(String comment)
```
  - setOrderPrinted
```
public void setOrderPrinted(double amount)
```
    Set an amount to determine for how many items the line has been printed to a kitchen order receipt. Used via TicketlineFormatter#setItemsPronted
    
    Parameters:
    
    amount - number of items printed
  - getComProducts
```
public String getComProducts()
```
  - setComProducts
```
public void setComProducts(String comProducts)
```
  - getOldAmount
```
public double getOldAmount()
```
  - setOldAmount
```
public void setOldAmount(double oldAmount)
```
  - compareTo
```
public int compareTo(TicketLine cline)
```
    Specified by:
    
    compareTo in interface Comparable<TicketLine>
  - getTotal_amount
```
public int getTotal_amount()
```
  - setTotal_amount
```
public void setTotal_amount(int total_amount)
```
  - getTare
```
public Integer getTare()
```
    The tare value is only stored for scale products.
    
    Returns:
    
    the tare value in gramm or null if no tare
  - setTare
```
public void setTare(Integer tare)
```
  - hasAccountingLevels
```
public boolean hasAccountingLevels(int levelMask)
```
    Returns true if at least one of the accounting levels in mask is set for the product assigned to the line.
    
    Parameters:
    
    levelMask -
    
    Returns:
    
    true if any match else false
  - printPlace
```
public String printPlace()
```
    Used for audit: get the name of the parent tickets place, if any.
    
    Returns:
    
    the name of the place or an empty string
  - getSeat
```
public Integer getSeat()
```
    Get the seat number as Byte The number of seats available can be limited through a custom variable.
    
    Returns:
    
    the seat number
  - setSeat
```
public void setSeat(Integer seat)
```
  - printCategoryName
```
public String printCategoryName()
```
    Print the category name of the associated product. If no associated product exists, 'free price entry' is assumed.
    
    Returns:
    
    the category name as String.
  - updateReservation
```
public void updateReservation()
```
    The cloning process for reservations does not set the resource_id properly. To avoid a null value updateReservation should be called for ach line after the ticket has been saved.
  - hasReservation
```
public boolean hasReservation()
```
    Convenience method to get the RESERVED status
    
    Returns:
    
    true if the line has status RESERVED
  - getPriceOrig
```
public Double getPriceOrig()
```
  - setPriceOrig
```
public void setPriceOrig(Double priceOrig)
```
  - save
```
public void save()
          throws BasicException
```
    Description copied from class: AbstractHibernateObject
    
    This is a convenience method to wrap the operation in a transaction. The current session contect is used. Hibernate should not be configured to close the session when a transaction is comitted. If the operation failes, the transaction is rolled back, the session is closed, and a BasicException is thrown. Take care not to use this method within a running transaction!
    
    Overrides:
    
    save in class AbstractHibernateObject<TicketLine>
    
    Throws:
    
    BasicException

Class TicketLine

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

Field Detail

STATUS_CREATED

STATUS_ORDERED

STATUS_PREPARING

STATUS_SERVING

STATUS_OUT

STATUS_LOCKED

STATUS_SELECTED

Constructor Detail

TicketLine

TicketLine

TicketLine

TicketLine

Method Detail

getReservation

setReservation

getProduct

setProduct

isProductCom

getDescription

setDescription

assignTaxes

assignTax

getAmount

setAmount

getParent

setParent

getPriceSell

setPriceSell

getPriceBuy

setPriceBuy

getTaxRate

setTaxRate

getReserved

setReserved

getProtect

setProtect

calculateTotal

calculateTotalOrig

calculateSubTotal

clone

getTax

getTaxes

setTax

setTaxes

getDiscountReason

setDiscountReason

getModifiers

setModifiers

getCook

setCook

getCourse

setCourse

getCreated_at

setCreated_at

getStatus

setStatus

isInactiveVoucher

setInactiveVoucher

isCoupon

setCoupon

isComProduct

setComProduct

getUpdated_at

setUpdated_at

lineIsPrinted

getOrderPrinted

lineIsPrinted

getComment

setComment

setOrderPrinted

getComProducts