ModifierFunctions (posper 3.0 API)

java.lang.Object
- org.posper.tpv.modifier.ModifierFunctions

```
public class ModifierFunctions
extends Object
```
This class defines the functions which can be called by modifiers. The functions must be defined according to the function attributes used in the xml source in Ticket.Modifiers. To allow proper deactivation of modifiers the method resetTicketline must be changed accordingly. // we do not apply modifiers when the product is not in the database. // Be aware that there are no // sensible base values for e.g. a discount calculation (we always have // to take the price stored in the ticketline so that discounts // would be accumulated when removed and reapplied). // This behaviour could be changed but I didn't see a reason - // a freely edited product normally needs not ro be modified

Author:

Hans

Constructor Summary

Constructors
Constructor and Description
`ModifierFunctions(TicketLine oTicketline, ModifierTimers oTimers, HashMap<Integer,Tax> mTaxes)` Creates an instance of ModifierFunctions to make the current ticketline available to all functions.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TicketLine`	`activateVoucher()` Calls activateVoucher(false)
`TicketLine`	`activateVoucher(boolean afterPayment)` Show a dialog to request scanning of a voucher and activate the voucher.
`TicketLine`	`addComProducts(String codes)` Set the transient ticketline property comProducts to the string 'codes'.
`TicketLine`	`buyNgetOneFree(int n)` Count the number of products on the current ticket and modify the price of the current item to fit the condition "Buy n Get One For Free".
`TicketLine`	`buyNgetOneFree(int n, String descmod)` Count the number of products on the current ticket and modify the price of the current item to fit the condition "Buy n Get One For Free".
`TicketLine`	`buyNmodifyNext(int n, String mod)` Count the number of products on the current ticket and modify the current line with the given modifier function.
`TicketLine`	`buyNmodifyNext(int n, String mod, String descmod)` Count the number of products on the current ticket and modify the current line with the given modifier function.
`TicketLine`	`checkRestrictedProduct()` Assign this function to an active product modifier to restrict users having the permission Perm.RestrictedProduct to add this product line. .
`TicketLine`	`checkRestrictedProduct(String permKey)` Assign this function to an active product modifier to restrict users having the permission permKey to add this product line. .
`TicketLine`	`createSlotReservation(int slot_type)` Creates a Reservation record for lines having a product assigned which has a slot_length entry like slot_30 in unitType and a value for the number of slots in units
`TicketLine`	`customerDiscount()` Looks for an entry in the customer discount table and applies the found discount rate if any.
`TicketLine`	`discount(double discountRate)` Applies the given discount rate based on the products priceSell.
`TicketLine`	`discount(double discountRate, int cent)` This method is identical to discountFromLineTotal(double discountRate, int cent)
`TicketLine`	`discountFromItem(double discountRate, int cent)` Applies the given discount rate based on the products priceSell.
`TicketLine`	`discountFromLineTotal(double discountRate, int cent)` Applies the given discount rate based on the products priceSell.
`TicketLine`	`discountX(double discountRate)` Deprecated. Use discount(double discountRate) instead.
`TicketLine`	`discountX(double discountRate, int cent)` Deprecated. Obolete, use discountFromLineTotal(double discountRate, int cent) instead.
`TicketLine`	`priceAndTaxShift(int price_index, int tax_index)` The price is calculated from the indexed price so that the the gross price matches the gross price with the given tax
`TicketLine`	`priceShift(int index)` Changes the products sell price from priceSell to the sell price indicated by index (0\|1\|2).
`TicketLine`	`protectLine()` Set status to PROTECTED to prevent unauthorized users from deleting or editing the ticketline.
`void`	`resetTicketline()` Resets all modified values to original product values.
`TicketLine`	`revertAmount()` Multiplies the number of items (amount) by -1.
`TicketLine`	`sellUnit(double factor)` Set the transient ticketline property addComProduct to the string 'codes' which is taken from the products unitType column.
`TicketLine`	`setNegativeAmount()` Set the number of items (amount) to -abs(amount).
`TicketLine`	`showMessage(String message)` Show a message dialog.
`TicketLine`	`showMessage(String message, String title)` Show a message dialog.
`TicketLine`	`specialPrice(int mod)` The function looks for a SpecialPrice assigned to the product and, if any, checks the cron-expression and date_from and date_to given in the SpecialPrice entry.
`TicketLine`	`taxShift(int taxId)` Applies the given taxId based on the products priceSell
`TicketLine`	`taxShiftFromTo_1(int... taxes_from_to)` Applies a tax shift from the from value, if found, to the to-value of the parameter list
`void`	`taxShiftFromTo(int from1, int to1, int from2, int to2)` This hack is necessary because the multiple int arguments version as in taxShiftFromTo_1 cannot be found when called by the beanshell.
`void`	`taxShiftFromTo(int from1, int to1, int from2, int to2, int from3, int to3)`
`void`	`taxShiftFromTo(int from1, int to1, int from2, int to2, int from3, int to3, int from4, int to4)`
`TicketLine`	`taxShiftKeepPrice(int taxId)` Applies the given taxId based on the products priceSell. priceSell is recalculated to keep the customer price stable.
`TicketLine`	`taxShiftKeepPriceFromTo_1(int... taxes_from_to)` Applies a tax shift from the from value, if found, to the to-value of the parameter list.
`void`	`taxShiftKeepPriceFromTo(int from1, int to1, int from2, int to2)`
`void`	`taxShiftKeepPriceFromTo(int from1, int to1, int from2, int to2, int from3, int to3)`
`void`	`taxShiftKeepPriceFromTo(int from1, int to1, int from2, int to2, int from3, int to3, int from4, int to4)`
`TicketLine`	`toggleAccountingLevels(int mask)` NOT YET IMPLEMENTED
`TicketLine`	`variableDiscount()` The discount rate is retrieved from the current value in the ticket views price input field.
`TicketLine`	`warnLockedProduct()` This modifier checks if the referenced product is locked.

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

- Constructor Detail
  - ModifierFunctions
```
public ModifierFunctions(TicketLine oTicketline,
                         ModifierTimers oTimers,
                         HashMap<Integer,Tax> mTaxes)
```
    Creates an instance of ModifierFunctions to make the current ticketline available to all functions.
    
    Parameters:
    
    oTicketline - current ticketline
    
    oTimers -
    
    mTaxes -
- Method Detail
  - resetTicketline
```
public void resetTicketline()
```
    Resets all modified values to original product values. If no product exists, nothing happens. If you modify other generic values than priceSell and tax values you must adapt this method
  - discount
```
public TicketLine discount(double discountRate)
```
    Applies the given discount rate based on the products priceSell. Please note that discounts are always calculated from the product price and thus cannot be accumulated! If no product exists, old values are taken from ticketline.
    
    Parameters:
    
    discountRate - discount rate to be applied, e.g. 10 for 10%
    
    Returns:
    
    the modified ticketline
  - variableDiscount
```
public TicketLine variableDiscount()
```
    The discount rate is retrieved from the current value in the ticket views price input field. The function works like discount(rate) but is not designed to be used other than being called through a function key.
    
    Returns:
    
    the modified ticketline
  - discountFromItem
```
public TicketLine discountFromItem(double discountRate,
                                   int cent)
```
    Applies the given discount rate based on the products priceSell. The result is rounded to the nearest cent value. The discount is applied to the product's gross priceSell, not the gross total of the TicketLine.
    
    Parameters:
    
    discountRate - discount rate to be applied, e.g. 10 for 10%
    
    cent - cent value to round to
    
    Returns:
    
    the modified ticketline
  - discountFromLineTotal
```
public TicketLine discountFromLineTotal(double discountRate,
                                        int cent)
```
    Applies the given discount rate based on the products priceSell. The result is rounded to the nearest cent value. The discount is applied to the gross total of the TicketLine, not the product's gross priceSell. This method can be used in countries where existing coins do not reflect pricing that results from caclulated discounts.
    
    Parameters:
    
    discountRate - discount rate to be applied, e.g. 10 for 10%
    
    cent - cent value to round to
    
    Returns:
    
    the modified ticketline
  - discount
```
public TicketLine discount(double discountRate,
                           int cent)
```
    This method is identical to discountFromLineTotal(double discountRate, int cent)
    
    Parameters:
    
    discountRate -
    
    cent -
    
    Returns:
    
    See Also:
    
    #discountTotal(double, int)
  - revertAmount
```
public TicketLine revertAmount()
```
    Multiplies the number of items (amount) by -1.
    
    Returns:
    
    the modified ticketline
  - setNegativeAmount
```
public TicketLine setNegativeAmount()
```
    Set the number of items (amount) to -abs(amount).
    
    Returns:
    
    the modified ticketline
  - discountX
```
public TicketLine discountX(double discountRate,
                            int cent)
```
    Deprecated. Obolete, use discountFromLineTotal(double discountRate, int cent) instead.
    
    Applies the given discount rate based on priceSell currently stored in the ticketline.The result is rounded to the nearest cent value.
    
    Parameters:
    
    discountRate - discount rate to be applied, e.g. 10 for 10%
    
    cent -
    
    Returns:
    
    the modified ticketline
  - discountX
```
public TicketLine discountX(double discountRate)
```
    Deprecated. Use discount(double discountRate) instead.
    
    Applies the given discount rate based on priceSell currently stored in the ticketline. Please note that discounts are normally calculated from the product price and should not be accumulated! This function breaks this rule.
    
    Parameters:
    
    discountRate - discount rate to be applied, e.g. 10 for 10%
    
    Returns:
    
    the modified ticketline
  - priceShift
```
public TicketLine priceShift(int index)
```
    Changes the products sell price from priceSell to the sell price indicated by index (0|1|2). Note, that other modifier functions like discount rely on the sell price stored in product and thus are not aware of price changes to the ticketline. 0 sets the product price.
    
    Parameters:
    
    index -
    
    Returns:
    
    the modified ticketline
  - taxShift
```
public TicketLine taxShift(int taxId)
```
    Applies the given taxId based on the products priceSell
    
    Parameters:
    
    taxId - tax id (=visibleId) to be applied
    
    Returns:
    
    the modified ticketline
  - taxShiftFromTo_1
```
public TicketLine taxShiftFromTo_1(int... taxes_from_to)
```
    Applies a tax shift from the from value, if found, to the to-value of the parameter list
    
    Parameters:
    
    taxes_from_to - a comma separated list of from,to pairs of tax visible ids to be shifted. If an odd number of values is given, the modifier does nothing.
    
    Returns:
    
    the modified ticketline
  - taxShiftKeepPriceFromTo_1
```
public TicketLine taxShiftKeepPriceFromTo_1(int... taxes_from_to)
```
    Applies a tax shift from the from value, if found, to the to-value of the parameter list. The original gross price will be kept.
    
    Parameters:
    
    taxes_from_to - a comma separated list of from,to pairs of tax visible ids to be shifted. If an odd number of values is given, the modifier does nothing.
    
    Returns:
    
    the modified ticketline
  - taxShiftFromTo
```
public void taxShiftFromTo(int from1,
                           int to1,
                           int from2,
                           int to2)
```
    This hack is necessary because the multiple int arguments version as in taxShiftFromTo_1 cannot be found when called by the beanshell.
    
    Parameters:
    
    from1 - tax visibleId to be changed
    
    to1 - new tax visibleId
    
    from2 - tax visibleId to be changed
    
    to2 - ew tax visibleId
  - taxShiftFromTo
```
public void taxShiftFromTo(int from1,
                           int to1,
                           int from2,
                           int to2,
                           int from3,
                           int to3)
```
  - taxShiftFromTo
```
public void taxShiftFromTo(int from1,
                           int to1,
                           int from2,
                           int to2,
                           int from3,
                           int to3,
                           int from4,
                           int to4)
```
  - taxShiftKeepPriceFromTo
```
public void taxShiftKeepPriceFromTo(int from1,
                                    int to1,
                                    int from2,
                                    int to2)
```
  - taxShiftKeepPriceFromTo
```
public void taxShiftKeepPriceFromTo(int from1,
                                    int to1,
                                    int from2,
                                    int to2,
                                    int from3,
                                    int to3)
```
  - taxShiftKeepPriceFromTo
```
public void taxShiftKeepPriceFromTo(int from1,
                                    int to1,
                                    int from2,
                                    int to2,
                                    int from3,
                                    int to3,
                                    int from4,
                                    int to4)
```
  - priceAndTaxShift
```
public TicketLine priceAndTaxShift(int price_index,
                                   int tax_index)
```
    The price is calculated from the indexed price so that the the gross price matches the gross price with the given tax
    
    Parameters:
    
    tax_index -
    
    price_index -
    
    Returns:
  - taxShiftKeepPrice
```
public TicketLine taxShiftKeepPrice(int taxId)
```
    Applies the given taxId based on the products priceSell. priceSell is recalculated to keep the customer price stable.
    
    Parameters:
    
    taxId - tax id to be applied
    
    Returns:
    
    the modified ticketline
  - customerDiscount
```
public TicketLine customerDiscount()
```
    Looks for an entry in the customer discount table and applies the found discount rate if any. If no record is found, no discount is applied.
    
    Returns:
    
    the modified ticketline
  - specialPrice
```
public TicketLine specialPrice(int mod)
```
    The function looks for a SpecialPrice assigned to the product and, if any, checks the cron-expression and date_from and date_to given in the SpecialPrice entry. The line is modified if today is in the date interval and the trigger entry is either empty or satisfied. If no record is found, the price is not modified and the modifier is removed from the lines mask. Also, a transient value priceBuySpecial is added to the ticketline.
    
    Parameters:
    
    mod - The modifier used to trigger this function
    
    Returns:
    
    the modified ticketline
  - addComProducts
```
public TicketLine addComProducts(String codes)
```
    Set the transient ticketline property comProducts to the string 'codes'. This is used to automatically add ticketlines with the products listed in codes to the modified Ticket. No display name should be defined and no reset will take place. Added lines must be manually removed if necessary. If com products are added they will automatically be removed if the associated ticketline is removed.
    
    Parameters:
    
    codes -
    
    Returns:
    
    the modified ticketline
  - sellUnit
```
public TicketLine sellUnit(double factor)
```
    Set the transient ticketline property addComProduct to the string 'codes' which is taken from the products unitType column. The original string contains a price field which is evaluated to modify the lines item price if the value is not zero.
    
    Parameters:
    
    factor -
    
    Returns:
    
    The modified line
  - buyNgetOneFree
```
public TicketLine buyNgetOneFree(int n,
                                 String descmod)
```
    Count the number of products on the current ticket and modify the price of the current item to fit the condition "Buy n Get One For Free". Example Buy 3 ... causes the 4th item to be registered with a price of 0. The description can be prepended or appended with a string. Note: This modifier will only work correctly if items are booked one by one and plus and minus are not used!
    
    Parameters:
    
    n - Number of items to be paid
    
    descmod - A string prepended to the description
    
    Returns:
  - buyNmodifyNext
```
public TicketLine buyNmodifyNext(int n,
                                 String mod,
                                 String descmod)
```
    Count the number of products on the current ticket and modify the current line with the given modifier function. The description can be prepended or appended with a string. Note: This modifier will only work correctly if items are booked one by one and plus and minus are not used!
    
    Parameters:
    
    n - Number of items to be paid
    
    mod -
    
    descmod - A string prepended to the description
    
    Returns:
  - buyNgetOneFree
```
public TicketLine buyNgetOneFree(int n)
```
    Count the number of products on the current ticket and modify the price of the current item to fit the condition "Buy n Get One For Free". Example Buy 3 ... causes the 4th item to be registered with a price of 0. Note: This modifier will only work correctly if items are booked one by one and plus and minus are not used!
    
    Parameters:
    
    n - Number of items to be paid
    
    Returns:
  - buyNmodifyNext
```
public TicketLine buyNmodifyNext(int n,
                                 String mod)
```
    Count the number of products on the current ticket and modify the current line with the given modifier function. Note: This modifier will only work correctly if items are booked one by one and plus and minus are not used!
    
    Parameters:
    
    n - Number of items to be paid
    
    mod -
    
    Returns:
  - toggleAccountingLevels
```
public TicketLine toggleAccountingLevels(int mask)
```
    NOT YET IMPLEMENTED
    
    Parameters:
    
    mask -
    
    Returns:
    
    the modified ticketline
  - warnLockedProduct
```
public TicketLine warnLockedProduct()
```
    This modifier checks if the referenced product is locked. If so, a warning dialog will be shown. If a replacement product is available the dialog will offer to accept the replacement
    
    Returns:
    
    the modified ticketline
  - protectLine
```
public TicketLine protectLine()
```
    Set status to PROTECTED to prevent unauthorized users from deleting or editing the ticketline.
    
    Returns:
    
    the modified ticketline
  - activateVoucher
```
public TicketLine activateVoucher(boolean afterPayment)
```
    Show a dialog to request scanning of a voucher and activate the voucher. Lines with activated vouchers will be protected.
    
    Parameters:
    
    afterPayment - when true, the activation dialog will be called per line when payment has been processed. Default is false.
    
    Returns:
    
    the modified ticketline
  - activateVoucher
```
public TicketLine activateVoucher()
```
    Calls activateVoucher(false)
    
    Returns:
    
    the modified ticketline
  - createSlotReservation
```
public TicketLine createSlotReservation(int slot_type)
```
    Creates a Reservation record for lines having a product assigned which has a slot_length entry like slot_30 in unitType and a value for the number of slots in units
    
    Parameters:
    
    slot_type - set 1 for jump_slot
    
    Returns:
    
    the otherwise unmodified ticketline.
  - checkRestrictedProduct
```
public TicketLine checkRestrictedProduct(String permKey)
```
    Assign this function to an active product modifier to restrict users having the permission permKey to add this product line. .
    
    Parameters:
    
    permKey -
    
    Returns:
    
    the ticketline
  - checkRestrictedProduct
```
public TicketLine checkRestrictedProduct()
```
    Assign this function to an active product modifier to restrict users having the permission Perm.RestrictedProduct to add this product line. .
    
    Returns:
    
    the ticketline
  - showMessage
```
public TicketLine showMessage(String message,
                              String title)
```
    Show a message dialog. The ticketline will not be modified
    
    Parameters:
    
    message -
    
    title -
    
    Returns:
  - showMessage
```
public TicketLine showMessage(String message)
```
    Show a message dialog. The ticketline will not be modified
    
    Parameters:
    
    message -
    
    Returns:

Class ModifierFunctions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModifierFunctions

Method Detail

resetTicketline

discount

variableDiscount

discountFromItem

discountFromLineTotal

discount

revertAmount

setNegativeAmount

discountX

discountX

priceShift

taxShift

taxShiftFromTo_1

taxShiftKeepPriceFromTo_1

taxShiftFromTo

taxShiftFromTo

taxShiftFromTo

taxShiftKeepPriceFromTo

taxShiftKeepPriceFromTo

taxShiftKeepPriceFromTo

priceAndTaxShift

taxShiftKeepPrice

customerDiscount

specialPrice

addComProducts

sellUnit

buyNgetOneFree

buyNmodifyNext

buyNgetOneFree

buyNmodifyNext

toggleAccountingLevels

warnLockedProduct

protectLine

activateVoucher

activateVoucher

createSlotReservation

checkRestrictedProduct

checkRestrictedProduct

showMessage

showMessage