com.ibm.retail.AEF.event
Interface StoreOptions

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

public interface StoreOptions
extends POSAppEventElement

StoreOptions is a simple data object to contain information about POS store level options. Store options determine what POS functions are enabled store-wide. StoreOptions are accessible from the OptionsEvent.

See Also:
getStoreOptions

Method Summary
 java.lang.String getCustomerFunctionCode()
          Get the customer function code.
 java.lang.String getMaximumSuspendedTransactions()
          Get the maximum number of suspended transactions allowed.
 java.lang.String getMaximumTransactionSize()
          Get the maximum size allowed for a transaction.
 java.util.Collection getTransactionDefinitions()
          Get the collection of transaction definitions.
 java.lang.String getTransactionWarningSize()
          Get the warning size for transactions.
 java.lang.String getVolumeInputDecimalPlaces()
          Get the number of decimal places for inputting volumes.
 java.lang.String getVolumeUnitPriceDecimalPlaces()
          Get the number of decimal places for volume unit prices.
 java.lang.String getWeightInputDecimalPlaces()
          Get the number of decimal places for inputting weights.
 java.lang.String getWICEBT()
          Get the identifier for WIC EBT
 boolean isEnabled(java.lang.String propertyName)
          Indicates if a function enabled or allowed.
 
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

isEnabled

public boolean isEnabled(java.lang.String propertyName)
                  throws AEFException
Indicates if a function enabled or allowed.

Since store options are application specific, isEnabled provides a method to determine the value of an option based on the property name of the function. Property names are contained in the StoreOptionsProperties interface.

Parameters:
propertyName - name of the property or function
Returns:
true if the function is enabled
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE
See Also:
StoreOptionsProperties

getMaximumTransactionSize

public java.lang.String getMaximumTransactionSize()
Get the maximum size allowed for a transaction.

Returns:
string representation of the maximum transaction size

getMaximumSuspendedTransactions

public java.lang.String getMaximumSuspendedTransactions()
Get the maximum number of suspended transactions allowed.

Returns:
string representation of the maximum number of suspended transactions

getTransactionWarningSize

public java.lang.String getTransactionWarningSize()
Get the warning size for transactions.

Returns:
string representation of the warning size

getCustomerFunctionCode

public java.lang.String getCustomerFunctionCode()
Get the customer function code.

Returns:
customer function code or POS key used

getWeightInputDecimalPlaces

public java.lang.String getWeightInputDecimalPlaces()
Get the number of decimal places for inputting weights.

Returns:
string representation of the number of decimal places

getVolumeInputDecimalPlaces

public java.lang.String getVolumeInputDecimalPlaces()
Get the number of decimal places for inputting volumes.

Returns:
string representation of the number of decimal places

getVolumeUnitPriceDecimalPlaces

public java.lang.String getVolumeUnitPriceDecimalPlaces()
Get the number of decimal places for volume unit prices.

Returns:
string representation of the number of decimal places

getWICEBT

public java.lang.String getWICEBT()
Get the identifier for WIC EBT

Returns:
string identifier of WIC EBT

getTransactionDefinitions

public java.util.Collection getTransactionDefinitions()
Get the collection of transaction definitions.

Returns:
Collection of TransactionDefinition objects - empty of no definitions included in this event
See Also:
TransactionDefinition


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