Modifiers (posper 3.0 API)

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

```
public class Modifiers
extends Object
```
The class Modifiers provides methods to set, unset, and retrieve modifier flags. A modifier is a flag associated with a function which must be defined in the class using ActiveModifier. getActions returns a list of function calls including the parameters defined for them.

Author:

Hans (ha)

Constructor Summary

Constructors
Constructor and Description
`Modifiers()` Creates a new Modifiers object retrieving the modifier definitions from the resource 'Tickets.Modifiers'.
`Modifiers(User oUser)`
`Modifiers(UserView oUser)` Creates a new Modifiers object and sets the user mask.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_getMask()` Retrieves the currently active modifiers in mask.
`static void`	`clearInputValue()` Clear the memorized input value (set to 0.0)
`static int`	`getCustomerGroupMask(TicketLine line)` Retrieves the active modifier mask for a customergroup
`static int`	`getCustomerMask(TicketLine line)` Retrieves the active modifier mask for a customer
`int`	`getDefaultCustomerGroupMask()` Use this method to assign a default mask for a new customer group The value is taken from ticket.modifiers.xml
`int`	`getDefaultCustomerMask()` Use this method to assign a default mask for a new customer The value is taken from ticket.modifiers.xml
`int`	`getDefaultProductExcludeMask()` Use this method to assign a default mask for a new products excluded modifiers.
`int`	`getDefaultProductMask()` Use this method to assign a default mask for a new products active modifiers.
`int`	`getDefaultUserMask()` Use this method to assign a default mask for a new user The value is taken from ticket.modifiers.xml
`String`	`getDisplayNames(int mask)` Retrieve the display names for all modifiers in the mask.
`String`	`getDisplayNames(TicketLine oLine)` Retrieve the display names for all modifiers to be applied.
`int`	`getGastroMask()`
`static double`	`getInputValue()` Used to pass an input value to a modifier function
`static Modifiers`	`getInstance()`
`int[]`	`getModifierIndices(int mask)` Lists the indices represented by mask (for the notion of indices see setModifierMask).
`HashMap<Integer,String>`	`getModifierMap()` Returns a list of all modifiers defined
`String[]`	`getModifierNames()` Lists the names of all defined modifiers.
`int`	`getRetailMask()`
`int`	`indicesToMask(int[] indices)` Create a modifier mask from the given indices.
`void`	`modifyTicketline(TicketLine oTicketline)` Modifies oTicketline according to the active modifiers.
`void`	`resetActive()`
`int`	`set(int oMask, int mask, Date lineDate)` Unlike setActive(mask) this function does not change the value of activeMask.
`int`	`setActive(int mask)`
`int`	`setActive(int mask, Date lineDate)` Activates the modifiers in mask. set checks which modifiers are excluded by those in mask and deactivates them.
`static void`	`setInputValue(double inputValue)` Store an input value to be used by a modifier function
`void`	`setUser(User oUser)`
`int`	`toggle(int oldMask, int mask, Date lineDate)` Unlike toggleActive(mask) this function does not change the value of activeMask.
`int`	`toggleActive(int mask, Date lineDate)` Toggle the modifiers in mask
`int`	`unset(int oldMask, int mask)` Unlike unsetActive(mask) this function does not change the value of activeMask.
`int`	`unsetActive(int mask)` Deactivates the modifiers in mask.

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

- Constructor Detail
  - Modifiers
```
public Modifiers()
```
    Creates a new Modifiers object retrieving the modifier definitions from the resource 'Tickets.Modifiers'. This constructor is used where we don't have a UserView and don't need the userMask anyway.
  - Modifiers
```
public Modifiers(UserView oUser)
```
    Creates a new Modifiers object and sets the user mask. This constructor should be used for modifier evaluation.
    
    Parameters:
    
    oUser -
  - Modifiers
```
public Modifiers(User oUser)
```
- Method Detail
  - getInputValue
```
public static double getInputValue()
```
    Used to pass an input value to a modifier function
    
    Returns:
    
    the emorized input value
  - clearInputValue
```
public static void clearInputValue()
```
    Clear the memorized input value (set to 0.0)
  - setInputValue
```
public static void setInputValue(double inputValue)
```
    Store an input value to be used by a modifier function
    
    Parameters:
    
    inputValue -
  - setUser
```
public void setUser(User oUser)
```
  - getInstance
```
public static Modifiers getInstance()
```
  - getModifierMap
```
public HashMap<Integer,String> getModifierMap()
```
    Returns a list of all modifiers defined
    
    Returns:
    
    the list of all modifiers defined
  - getModifierNames
```
public String[] getModifierNames()
```
    Lists the names of all defined modifiers.
    
    Returns:
    
    a list of modifier names in the same order as they are defined in Ticket.Modifiers.
  - indicesToMask
```
public int indicesToMask(int[] indices)
```
    Create a modifier mask from the given indices. Note that the indices do not necessarily represent the modifier id but the rank in the Ticket.Modifier template.
    
    Parameters:
    
    indices - an array of integers each representing the index (not the Id) of a modifier in Ticket.Modifiers.
    
    Returns:
    
    a modifier mask representing the given modifiers
  - getModifierIndices
```
public int[] getModifierIndices(int mask)
```
    Lists the indices represented by mask (for the notion of indices see setModifierMask).
    
    Parameters:
    
    mask - is a modifier mask
    
    Returns:
    
    a list of indices.
  - setActive
```
public int setActive(int mask,
                     Date lineDate)
```
    Activates the modifiers in mask. set checks which modifiers are excluded by those in mask and deactivates them. Only those modifiers in mask are activated which are not excluded by other modifiers being already set. If two modifiers in a mask exclude each other, none of them is set.
    
    Parameters:
    
    mask - a bit mask of modifiers to be activated
    
    lineDate - exclude timer excluded modifiers
    
    Returns:
    
    the current mask of active modifiers
  - setActive
```
public int setActive(int mask)
```
  - set
```
public int set(int oMask,
               int mask,
               Date lineDate)
```
    Unlike setActive(mask) this function does not change the value of activeMask.
    
    Parameters:
    
    oMask - mask to be changed
    
    mask - mask to be added modifiers in mask are added to oldMask
    
    lineDate - exclude timer excluded modifiers
    
    Returns:
    
    the reulting mask
  - unsetActive
```
public int unsetActive(int mask)
```
    Deactivates the modifiers in mask. No excluded modifiers are reactivated at this point. Global and time controlled modifiers are checked only when getActions is called.
    
    Parameters:
    
    mask - a bit mask of modifiers to be deactivated
    
    Returns:
    
    the current mask of active modifiers
  - resetActive
```
public void resetActive()
```
  - unset
```
public int unset(int oldMask,
                 int mask)
```
    Unlike unsetActive(mask) this function does not change the value of activeMask.
    
    Parameters:
    
    oldMask - the base mask
    
    mask - modifiers in mask are subrtacted from oldMask
    
    Returns:
    
    the reulting mask
  - toggleActive
```
public int toggleActive(int mask,
                        Date lineDate)
```
    Toggle the modifiers in mask
    
    Parameters:
    
    mask - a bit mask of modifiers to be toggled
    
    lineDate - exclude timer excluded modifiers by lineDate
    
    Returns:
    
    the current mask of active modifiers
  - toggle
```
public int toggle(int oldMask,
                  int mask,
                  Date lineDate)
```
    Unlike toggleActive(mask) this function does not change the value of activeMask.
    
    Parameters:
    
    oldMask - the base mask
    
    mask - modifiers in mask are toggled in oldMask
    
    lineDate - exclude timer excluded modifiers by lineDate
    
    Returns:
  - _getMask
```
public int _getMask()
```
    Retrieves the currently active modifiers in mask. For testing purposes only!!
    
    Returns:
    
    the current mask of active modifiers
  - getDisplayNames
```
public String getDisplayNames(int mask)
```
    Retrieve the display names for all modifiers in the mask. The mask is not evaluated before looking up the names.
    
    Parameters:
    
    mask - input mask
    
    Returns:
  - getDisplayNames
```
public String getDisplayNames(TicketLine oLine)
```
    Retrieve the display names for all modifiers to be applied. The given mask is evaluated before the modifiers are looked up
    
    Parameters:
    
    oLine - the line to get the modifiers from
    
    Returns:
  - getDefaultUserMask
```
public int getDefaultUserMask()
```
    Use this method to assign a default mask for a new user The value is taken from ticket.modifiers.xml
    
    Returns:
  - getDefaultCustomerMask
```
public int getDefaultCustomerMask()
```
    Use this method to assign a default mask for a new customer The value is taken from ticket.modifiers.xml
    
    Returns:
  - getDefaultCustomerGroupMask
```
public int getDefaultCustomerGroupMask()
```
    Use this method to assign a default mask for a new customer group The value is taken from ticket.modifiers.xml
    
    Returns:
  - getDefaultProductMask
```
public int getDefaultProductMask()
```
    Use this method to assign a default mask for a new products active modifiers. The value is taken from ticket.modifiers.xml
    
    Returns:
  - getDefaultProductExcludeMask
```
public int getDefaultProductExcludeMask()
```
    Use this method to assign a default mask for a new products excluded modifiers. The value is taken from ticket.modifiers.xml
    
    Returns:
  - getRetailMask
```
public int getRetailMask()
```
  - getGastroMask
```
public int getGastroMask()
```
  - modifyTicketline
```
public void modifyTicketline(TicketLine oTicketline)
```
    Modifies oTicketline according to the active modifiers. The tickets mask is evaluated. The ticketline will be reset before applying the new modifier actions. For every active modifier the respective function will be called.
    
    Parameters:
    
    oTicketline -
  - getCustomerMask
```
public static int getCustomerMask(TicketLine line)
```
    Retrieves the active modifier mask for a customer
    
    Parameters:
    
    line -
    
    Returns:
    
    the mask assigned to the product
  - getCustomerGroupMask
```
public static int getCustomerGroupMask(TicketLine line)
```
    Retrieves the active modifier mask for a customergroup
    
    Parameters:
    
    line - ticketline to retrieve the mask from
    
    Returns:
    
    the mask assigned to the customergroup

Class Modifiers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Modifiers

Modifiers

Modifiers

Method Detail

getInputValue

clearInputValue

setInputValue

setUser

getInstance

getModifierMap

getModifierNames

indicesToMask

getModifierIndices

setActive

setActive

set

unsetActive

resetActive

unset

toggleActive

toggle

_getMask

getDisplayNames

getDisplayNames

getDefaultUserMask

getDefaultCustomerMask

getDefaultCustomerGroupMask

getDefaultProductMask

getDefaultProductExcludeMask

getRetailMask

getGastroMask

modifyTicketline

getCustomerMask

getCustomerGroupMask