Ticket (posper 3.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable, Auditable
```
public class Ticket
extends AbstractVisiblyIdentifiedHibernateObject<Ticket>
implements Cloneable, Auditable
```
This class describes a Ticket. A ticket is composed of some fields, and a List of tickets lines. Changes:
- create visibleId outside of model to avoid gaps caused by ticket instances created through queries
- added calculateDebt
- added retrievePaymentInfo
- added comment
- clone fixed: lines will get the right parent id assigned

Author:

Hans, manuelnaranjo, Aaron Luchko

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Integer`	`CLOSED`
`static Integer`	`DELIVERED`
`static Integer`	`DELIVERY`
`static Integer`	`ERP`
`static Integer`	`NORMAL`
`static Integer`	`ORDER`
`static Integer`	`SPLIT`
`static Integer`	`TRAINING`
`static Integer`	`UNLOCKED`
`static Integer`	`UNSIGNED`
`static Integer`	`UPDATED`
`static Integer`	`VOID`
`static Integer`	`VOIDING`
`static Integer`	`VOUCHER`

Fields inherited from class org.posper.hibernate.AbstractVisiblyIdentifiedHibernateObject
visibleId

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

Constructor Summary

Constructors
Constructor and Description

Ticket()
Creates a new instance of Ticket

Constructors
Constructor and Description
`Ticket()` Creates a new instance of Ticket

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLine(TicketLine line)`
`void`	`addPayment(Payment payment)` Convenience method so we can have a bidirectional relationship still controlled by the payment
`void`	`auditDeletion()`
`double`	`calculateDebt()` Calculates the sum of all paperin/paperout payments which is regarded the outstanding amount.
`double`	`calculateSubTotal()`
`double`	`calculateTaxes()`
`double`	`calculateTotal()`
`double`	`calculateTotalPayments()`
`void`	`clearPayments()` Removes all payment records from the ticket.
`Ticket`	`clone()` Cloning a ticket creates a deep copy including lines and payments.
`Ticket`	`cloneWithoutPayments()` In some cases we need a clone without payments like for 'Edit sale'.
`String`	`getComment()`
`Date`	`getCreated_at()`
`MagCardReader`	`getCreditCard()` This transient property indicates that we have swiped a credit card and, if configured, want to process the ticket through the configured credit card gateway for full payment.
`Customer`	`getCustomer()`
`Date`	`getDateClose()`
`Date`	`getDateDelivered()`
`Date`	`getDateDueDelivery()`
`Date`	`getDateOpen()`
`Integer`	`getGuests()`
`Boolean`	`getHasNegativeLines()`
`String`	`getHost()`
`List<TicketLine>`	`getLines()` A ticket lines is what you see on a ticket.
`Integer`	`getNumber()`
`String`	`getOrderCode()` orderCode is meant to store an order code from a foreign ERP system for back reference
`CashRegister`	`getParent()` The parent of each ticket, is the Active Cash Register.
`List<Payment>`	`getPayments()` This returns a list of the payments used to pay this ticket.
`Place`	`getPlace()`
`Integer`	`getReference()`
`String`	`getSignature()`
`Integer`	`getStatus()`
`static Ticket`	`getTicketByNumber(Integer iTicketNumber)` Retrieve a closed ticket by the ticket number
`static Ticket`	`getTicketByVisibleID(Integer iTicketVisibleID)` Retrieve a ticket by the visibleID.
`Boolean`	`getToGo()`
`Long`	`getTransactionNumber()` The transactionNumber is created by startTransaction when the German Fiscal Security Element (TSE) is used
`Long`	`getTurnover()` For future use
`Date`	`getUpdated_at()`
`User`	`getUser()`
`String`	`getValueCard()`
`String`	`getzipCodeRes()` Return the customer field content of the first associated reservation found.
`boolean`	`hasAccess(User oUser)`
`boolean`	`hasMembercardPayment()`
`boolean`	`hasProtectedLines()`
`boolean`	`hasReservations()`
`boolean`	`hasStatus(Integer status)` Check if the ticket has the given status
`boolean`	`inActiveCash()` Check if the ticket is closed and registered in active cash
`boolean`	`isEmpty()`
`boolean`	`isOverdue()`
`Boolean`	`isSynched()`
`boolean`	`isTraining()`
`boolean`	`isValid()` We set the status to UNSIGNED if the transaction could not be started or finished - for German SE only.
`Boolean`	`isVoided()` Returns true if either the ticket belongs to the CANCELLED register or has the CANCEL status bit set.
`Boolean`	`isVoiding()` Returns true if the ticket has the VOIDING status bit set.
`int`	`newVisibleId()`
`long`	`overdueTime()`
`String`	`printPlaceName()` Used for audit: get the name of the tickets place, if any.
`double`	`retrievePaymentInfo()` Retrieves paid amount and debt and set PaymentInfo accordingly.
`Date`	`returnReservationDate()` Check if the ticket has lines with status RESERVED
`void`	`revertGatewayPayments()` Revert all gateway payments but do not remove the payments from the ticket.
`void`	`setComment(String comment)`
`void`	`setCreated_at(Date created_at)`
`void`	`setCreditCard(MagCardReader creditCardReader)`
`void`	`setCustomer(Customer customer)`
`void`	`setDateClose(Date close)`
`void`	`setDateDelivered(Date dateDelivered)`
`void`	`setDateDueDelivery(Date dateDueDelivery)`
`void`	`setDateOpen(Date dateOpen)`
`void`	`setGuests(Integer guests)`
`void`	`setHasNegativeLines(Boolean hasNegativeLines)`
`void`	`setHost(String host)`
`void`	`setLines(List<TicketLine> new_lines)`
`void`	`setNumber(Integer number)`
`void`	`setOrderCode(String orderCode)` Set optionally when backreference to foreign order codes is needed
`void`	`setParent(CashRegister newparent)`
`void`	`setPayments(List<Payment> payments)`
`void`	`setPlace(Place place)`
`void`	`setReference(Integer reference)`
`void`	`setSignature(String signature)`
`void`	`setStatus(Integer status)` Set the status field to the value of status.
`void`	`setStatusFlag(int flag)` Set the bits in the status field according to flag.
`void`	`setSynched(Boolean synched)`
`void`	`setToGo(Boolean toGo)`
`void`	`setTransactionNumber(Long transactionNumber)`
`void`	`setTurnover(Long turnover)` For future use;
`void`	`setUpdated_at(Date updated_at)`
`void`	`setUser(User us)`
`void`	`setValueCard(String valueCard)`
`void`	`setZipCode(String zip_code)` Store the zip_code in the comment field.
`void`	`setZipCodeRes(String zip_code)` Store the zip_code in the customer field of all associated reservations
`void`	`toggleStatusFlag(Integer flag)` Toggle the bits in the status field according to flag.
`void`	`unsetStatusFlag(Integer flag)` Unset the bits in the status field according to flag.
`void`	`updateAllReservationTimes(Date oDateRes)` Update the reservation time of all lines with status RESERVED.
`void`	`validate()` Assign a number to this ticket and generate a signature if appropriate.

Methods inherited from class org.posper.hibernate.AbstractVisiblyIdentifiedHibernateObject
getVisibleId, setVisibleId

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
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NORMAL
```
public static final Integer NORMAL
```
  - SPLIT
```
public static final Integer SPLIT
```
  - CLOSED
```
public static final Integer CLOSED
```
  - ORDER
```
public static final Integer ORDER
```
  - DELIVERY
```
public static final Integer DELIVERY
```
  - DELIVERED
```
public static final Integer DELIVERED
```
  - UNLOCKED
```
public static final Integer UNLOCKED
```
  - ERP
```
public static final Integer ERP
```
  - UPDATED
```
public static final Integer UPDATED
```
  - VOUCHER
```
public static final Integer VOUCHER
```
  - VOID
```
public static final Integer VOID
```
  - VOIDING
```
public static final Integer VOIDING
```
  - TRAINING
```
public static final Integer TRAINING
```
  - UNSIGNED
```
public static final Integer UNSIGNED
```
- Constructor Detail
  - Ticket
```
public Ticket()
```
    Creates a new instance of Ticket
- Method Detail
  - getDateOpen
```
public Date getDateOpen()
```
  - setDateOpen
```
public void setDateOpen(Date dateOpen)
```
  - getDateClose
```
public Date getDateClose()
```
  - setDateClose
```
public void setDateClose(Date close)
```
  - getCustomer
```
public Customer getCustomer()
```
    Returns:
    
    the customer
  - setCustomer
```
public void setCustomer(Customer customer)
```
  - getDateDelivered
```
public Date getDateDelivered()
```
  - setDateDelivered
```
public void setDateDelivered(Date dateDelivered)
```
  - getDateDueDelivery
```
public Date getDateDueDelivery()
```
  - setDateDueDelivery
```
public void setDateDueDelivery(Date dateDueDelivery)
```
  - getComment
```
public String getComment()
```
  - setComment
```
public void setComment(String comment)
```
  - getParent
```
public CashRegister getParent()
```
    The parent of each ticket, is the Active Cash Register.
    
    Returns:
    
    parent cashregister_id
  - setParent
```
public void setParent(CashRegister newparent)
```
  - getLines
```
public List<TicketLine> getLines()
```
    A ticket lines is what you see on a ticket. Is the dynamic data of it.
    
    Returns:
    
    the list of ticketlines associated with this ticket
  - setLines
```
public void setLines(List<TicketLine> new_lines)
```
  - getUser
```
public User getUser()
```
  - setUser
```
public void setUser(User us)
```
  - newVisibleId
```
public int newVisibleId()
                 throws BasicException
```
    Throws:
    
    BasicException
  - calculateTaxes
```
public double calculateTaxes()
```
  - calculateSubTotal
```
public double calculateSubTotal()
```
    Returns:
  - calculateTotal
```
public double calculateTotal()
```
    Returns:
  - calculateDebt
```
public double calculateDebt()
```
    Calculates the sum of all paperin/paperout payments which is regarded the outstanding amount.
    
    Returns:
    
    sum of paperin and paperout payments
  - calculateTotalPayments
```
public double calculateTotalPayments()
```
  - getHost
```
public String getHost()
```
    Returns:
    
    the host
  - setHost
```
public void setHost(String host)
```
    Parameters:
    
    host - the host to set
  - getNumber
```
public Integer getNumber()
```
    Returns:
    
    the number
  - setNumber
```
public void setNumber(Integer number)
```
    Parameters:
    
    number - the number to set
  - validate
```
public void validate()
              throws BasicException
```
    Assign a number to this ticket and generate a signature if appropriate.
    
    Throws:
    
    BasicException - if no number could be asigned. No signature will be generated in this case.
  - getPayments
```
public List<Payment> getPayments()
```
    This returns a list of the payments used to pay this ticket.
    
    Returns:
    
    a list of the payments
  - setPayments
```
public void setPayments(List<Payment> payments)
```
  - getPlace
```
public Place getPlace()
```
  - setPlace
```
public void setPlace(Place place)
```
  - clone
```
public Ticket clone()
             throws CloneNotSupportedException
```
    Cloning a ticket creates a deep copy including lines and payments. Instead of a straight clone we actually assign new UUIDs to the ticket, lines, and payments, since those values might be altered/deleted and we need an original copy which doesn't confuse hibernate by sharing the same id in the cache. I think, in this implementation the id problem has been successfully tackled with the merge (Hans).
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    The cloned ticket as open ticket
    
    Throws:
    
    CloneNotSupportedException
  - cloneWithoutPayments
```
public Ticket cloneWithoutPayments()
```
    In some cases we need a clone without payments like for 'Edit sale'. We must not clone payments because we would have to remove them before we are going to close the cloned and edited ticket. This would create havoc with payments that were made over a payment gateway because we still need them unitil we can finally remove the original. The cloned ticket must have the sync flag reset, the signature set to null, and number set to null.
    
    Returns:
  - isSynched
```
public Boolean isSynched()
```
  - setSynched
```
public void setSynched(Boolean synched)
```
  - getStatus
```
public Integer getStatus()
```
  - setStatus
```
public void setStatus(Integer status)
```
    Set the status field to the value of status.
    
    Parameters:
    
    status -
  - setStatusFlag
```
public void setStatusFlag(int flag)
```
    Set the bits in the status field according to flag.
    
    Parameters:
    
    flag -
  - toggleStatusFlag
```
public void toggleStatusFlag(Integer flag)
```
    Toggle the bits in the status field according to flag.
    
    Parameters:
    
    flag -
  - unsetStatusFlag
```
public void unsetStatusFlag(Integer flag)
```
    Unset the bits in the status field according to flag.
    
    Parameters:
    
    flag -
  - hasStatus
```
public boolean hasStatus(Integer status)
```
    Check if the ticket has the given status
    
    Parameters:
    
    status -
    
    Returns:
    
    true if the ticket has at least one the given status bits set, false otherwise
  - addPayment
```
public void addPayment(Payment payment)
```
    Convenience method so we can have a bidirectional relationship still controlled by the payment
    
    Parameters:
    
    payment -
  - addLine
```
public void addLine(TicketLine line)
```
  - hasMembercardPayment
```
public boolean hasMembercardPayment()
```
  - clearPayments
```
public void clearPayments()
                   throws AggregateException
```
    Removes all payment records from the ticket. Gateway payments are tried to be reverted. If this fails for a gateway the user will be notified and an error receipt can be printed so that this can be fixed with the gateway provider. Also, an audit log entry will be written for every reversal showing success or failure. All payments assigned to the ticket will be removed in any case.
    
    Throws:
    
    AggregateException
  - revertGatewayPayments
```
public void revertGatewayPayments()
                           throws AggregateException
```
    Revert all gateway payments but do not remove the payments from the ticket.
    
    Throws:
    
    AggregateException
  - auditDeletion
```
public void auditDeletion()
```
  - retrievePaymentInfo
```
public double retrievePaymentInfo()
```
    Retrieves paid amount and debt and set PaymentInfo accordingly. Debt is returned for convenience. This method will attach a PaymentInfoNote object if there are any paperin/paperout payments and debt > 0.
    
    Returns:
    
    debt representing the sum of all paperin and paperout payments
  - isVoided
```
public Boolean isVoided()
```
    Returns true if either the ticket belongs to the CANCELLED register or has the CANCEL status bit set. In both cases the ticket must neither be edited or cancelled a second time.
    
    Returns:
  - isVoiding
```
public Boolean isVoiding()
```
    Returns true if the ticket has the VOIDING status bit set.
    
    Returns:
  - getValueCard
```
public String getValueCard()
```
  - setValueCard
```
public void setValueCard(String valueCard)
```
  - getCreditCard
```
public MagCardReader getCreditCard()
```
    This transient property indicates that we have swiped a credit card and, if configured, want to process the ticket through the configured credit card gateway for full payment.
    
    Returns:
    
    the raw credit card string
  - setCreditCard
```
public void setCreditCard(MagCardReader creditCardReader)
```
  - getGuests
```
public Integer getGuests()
```
  - setGuests
```
public void setGuests(Integer guests)
```
  - getOrderCode
```
public String getOrderCode()
```
    orderCode is meant to store an order code from a foreign ERP system for back reference
    
    Returns:
    
    the orderCode as String
  - setOrderCode
```
public void setOrderCode(String orderCode)
```
    Set optionally when backreference to foreign order codes is needed
    
    Parameters:
    
    orderCode -
  - printPlaceName
```
public String printPlaceName()
```
    Used for audit: get the name of the tickets place, if any.
    
    Returns:
    
    the name of the place or an empty string
  - getTicketByNumber
```
public static Ticket getTicketByNumber(Integer iTicketNumber)
```
    Retrieve a closed ticket by the ticket number
    
    Parameters:
    
    iTicketNumber -
    
    Returns:
    
    the ticket or null
  - getTicketByVisibleID
```
public static Ticket getTicketByVisibleID(Integer iTicketVisibleID)
```
    Retrieve a ticket by the visibleID. Note, that this method also returns open tickets as opposed to getTicketByNumber
    
    Parameters:
    
    iTicketVisibleID -
    
    Returns:
    
    the ticket or null
  - hasAccess
```
public boolean hasAccess(User oUser)
```
  - overdueTime
```
public long overdueTime()
```
  - isOverdue
```
public boolean isOverdue()
```
  - isEmpty
```
public boolean isEmpty()
```
  - returnReservationDate
```
public Date returnReservationDate()
```
    Check if the ticket has lines with status RESERVED
    
    Returns:
    
    true if any line has the status RESERVED
  - updateAllReservationTimes
```
public void updateAllReservationTimes(Date oDateRes)
```
    Update the reservation time of all lines with status RESERVED.
  - setZipCodeRes
```
public void setZipCodeRes(String zip_code)
```
    Store the zip_code in the customer field of all associated reservations
    
    Parameters:
    
    zip_code -
  - setZipCode
```
public void setZipCode(String zip_code)
```
    Store the zip_code in the comment field. Append with ';' if not empzty
    
    Parameters:
    
    zip_code -
  - getzipCodeRes
```
public String getzipCodeRes()
```
    Return the customer field content of the first associated reservation found. This should contain the zip code.
    
    Returns:
  - getSignature
```
public String getSignature()
```
  - setSignature
```
public void setSignature(String signature)
```
  - hasReservations
```
public boolean hasReservations()
```
  - inActiveCash
```
public boolean inActiveCash()
```
    Check if the ticket is closed and registered in active cash
    
    Returns:
    
    true or false
  - getUpdated_at
```
public Date getUpdated_at()
```
  - setUpdated_at
```
public void setUpdated_at(Date updated_at)
```
    Specified by:
    
    setUpdated_at in interface Auditable
  - getCreated_at
```
public Date getCreated_at()
```
  - setCreated_at
```
public void setCreated_at(Date created_at)
```
    Specified by:
    
    setCreated_at in interface Auditable
  - hasProtectedLines
```
public boolean hasProtectedLines()
```
  - getToGo
```
public Boolean getToGo()
```
  - setToGo
```
public void setToGo(Boolean toGo)
```
  - getHasNegativeLines
```
public Boolean getHasNegativeLines()
```
  - setHasNegativeLines
```
public void setHasNegativeLines(Boolean hasNegativeLines)
```
  - getTurnover
```
public Long getTurnover()
```
    For future use
    
    Returns:
  - setTurnover
```
public void setTurnover(Long turnover)
```
    For future use;
    
    Parameters:
    
    turnover -
  - getTransactionNumber
```
public Long getTransactionNumber()
```
    The transactionNumber is created by startTransaction when the German Fiscal Security Element (TSE) is used
    
    Returns:
  - setTransactionNumber
```
public void setTransactionNumber(Long transactionNumber)
```
  - getReference
```
public Integer getReference()
```
  - setReference
```
public void setReference(Integer reference)
```
  - isTraining
```
public boolean isTraining()
```
  - isValid
```
public boolean isValid()
```
    We set the status to UNSIGNED if the transaction could not be started or finished - for German SE only.
    
    Returns:
    
    true if we have a valid finished transaction.

Class Ticket

Field Summary

Fields inherited from class org.posper.hibernate.AbstractVisiblyIdentifiedHibernateObject

Fields inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject

Constructor Summary

Method Summary

Methods inherited from class org.posper.hibernate.AbstractVisiblyIdentifiedHibernateObject

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

NORMAL

SPLIT

CLOSED

ORDER

DELIVERY

DELIVERED

UNLOCKED

ERP

UPDATED

VOUCHER

VOID

VOIDING

TRAINING

UNSIGNED

Constructor Detail

Ticket

Method Detail

getDateOpen

setDateOpen

getDateClose

setDateClose

getCustomer

setCustomer

getDateDelivered

setDateDelivered

getDateDueDelivery

setDateDueDelivery

getComment

setComment

getParent

setParent

getLines

setLines

getUser

setUser

newVisibleId

calculateTaxes

calculateSubTotal

calculateTotal

calculateDebt

calculateTotalPayments

getHost

setHost

getNumber

setNumber

validate

getPayments

setPayments

getPlace

setPlace

clone

cloneWithoutPayments

isSynched

setSynched

getStatus

setStatus

setStatusFlag

toggleStatusFlag

unsetStatusFlag

hasStatus

addPayment

addLine

hasMembercardPayment

clearPayments

revertGatewayPayments

auditDeletion

retrievePaymentInfo

isVoided

isVoiding