com.ibm.retail.AEF.event
Interface OptionsEvent

All Superinterfaces:
POSAppEvent, POSAppEventElement, SAXElementHandler, java.io.Serializable

public interface OptionsEvent
extends POSAppEvent

An OptionsEvent is generated whenever terminal or store level options are loaded for the POS Terminal Sales Application. This options determine the functions available at the terminal and modify the configurable behavior of the terminal.


Method Summary
 java.util.Collection getAlternateTaxCodes()
          Returns list of the tax codes used for identifying alternate tax codes
 java.util.Collection getDepartmentDefinitions()
          Returns list of the departments defined
 java.util.Collection getItemDiscountReasons()
          Returns list of the discount reason codes used for processing item discounts
 java.util.Collection getManualTaxCodes()
          Returns list of the tax codes used for identifying manual tax codes
 java.util.Collection getNoTaxCodes()
          Returns list of the tax codes used for identifying no tax codes
 java.util.Collection getPriceOverrideReasons()
          Returns list of the reason codes used for price overrides
 java.util.Collection getRefundReasons()
          Returns list of the reason codes used for refunds
 com.ibm.retail.AEF.event.StoreDefinition getStoreDefinition()
          Returns the information about the store (name, address,..)
 com.ibm.retail.AEF.event.StoreOptions getStoreOptions()
          Returns information about store wide options
 java.util.Collection getTareCodes()
          Returns list of the codes used for identifying tares
 java.util.Collection getTenderDefinitions()
          Returns a list of tenders defined
 com.ibm.retail.AEF.event.TerminalOptions getTerminalOptions()
          Returns information about the terminal specific options
 java.util.Collection getTransactionDiscountReasons()
          Returns list of the discount reason codes used for processing transaction discounts
 java.util.Collection getVATTaxCodes()
          Returns list of the tax codes used for identifying VAT
 java.util.Collection getVoidReasons()
          Returns list of the reason codes used for voids
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEvent
getEventType, getPropertyChangeCategory, getTerminalNumber, setEventType, setTerminalNumber
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEventElement
getBooleanPropertyValue, getData, getIntegerPropertyValue, getProperty, getPropertyEntries, setData, setProperty, toString
 
Methods inherited from interface com.ibm.retail.AEF.xml.SAXElementHandler
endElement, startElement
 

Method Detail

getStoreDefinition

public com.ibm.retail.AEF.event.StoreDefinition getStoreDefinition()
Returns the information about the store (name, address,..)

Returns:
StoreDefinition object

getTenderDefinitions

public java.util.Collection getTenderDefinitions()
Returns a list of tenders defined

Returns:
Collection of TenderDefinition objects - empty collection if no tender definitions were contained in the event
See Also:
TenderDefinition

getPriceOverrideReasons

public java.util.Collection getPriceOverrideReasons()
Returns list of the reason codes used for price overrides

Returns:
Collection of ReasonCode objects - empty collection if no reason codes for price overrides were contained in the event
See Also:
ReasonCode

getRefundReasons

public java.util.Collection getRefundReasons()
Returns list of the reason codes used for refunds

Returns:
Collection of ReasonCode objects - empty collection if no reason codes for refunds were contained in the event
See Also:
ReasonCode

getVoidReasons

public java.util.Collection getVoidReasons()
Returns list of the reason codes used for voids

Returns:
Collection of ReasonCode objects - empty collection if no reason codes for voids were contained in the event
See Also:
ReasonCode

getTareCodes

public java.util.Collection getTareCodes()
Returns list of the codes used for identifying tares

Returns:
Collection of TareCode objects - empty collection if no tare codes were contained in the event
See Also:
TareCode

getVATTaxCodes

public java.util.Collection getVATTaxCodes()
Returns list of the tax codes used for identifying VAT

Returns:
Collection of TaxCode objects - empty collection if no VAT tax codes were contained in the event
See Also:
TaxCode

getAlternateTaxCodes

public java.util.Collection getAlternateTaxCodes()
Returns list of the tax codes used for identifying alternate tax codes

Returns:
Collection of TaxCode objects - empty collection if no alternate tax codes were contained in the event
See Also:
TaxCode

getManualTaxCodes

public java.util.Collection getManualTaxCodes()
Returns list of the tax codes used for identifying manual tax codes

Returns:
Collection of TaxCode objects - empty collection if no manual tax codes were contained in the event
See Also:
TaxCode

getNoTaxCodes

public java.util.Collection getNoTaxCodes()
Returns list of the tax codes used for identifying no tax codes

Returns:
Collection of TaxCode objects - empty collection if no manual tax codes were contained in the event
See Also:
TaxCode

getItemDiscountReasons

public java.util.Collection getItemDiscountReasons()
Returns list of the discount reason codes used for processing item discounts

Returns:
Collection of DiscountReasonCode objects - empty collection if no item discount reason codes were contained in the event
See Also:
DiscountReasonCode

getTransactionDiscountReasons

public java.util.Collection getTransactionDiscountReasons()
Returns list of the discount reason codes used for processing transaction discounts

Returns:
Collection of TransactionDiscountReasonCode objects - empty collection if no transaction discount reason codes were contained in the event
See Also:
TransactionDiscountReasonCode

getDepartmentDefinitions

public java.util.Collection getDepartmentDefinitions()
Returns list of the departments defined

Returns:
Collection of DepartmentDefinition objects - empty collection if no departments were defined in the event
See Also:
DepartmentDefinition

getTerminalOptions

public com.ibm.retail.AEF.event.TerminalOptions getTerminalOptions()
Returns information about the terminal specific options

Returns:
TerminalOptions object describing the options for this terminal - null if no terminal options defined

getStoreOptions

public com.ibm.retail.AEF.event.StoreOptions getStoreOptions()
Returns information about store wide options

Returns:
StoreOptions object describing store-wide options - null if no terminal options defined


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004