com.ibm.retail.AEF.event
Interface PointsEvent

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

public interface PointsEvent
extends LineItemEvent

A PointsEvent is generated when loyalty points are awarded or redeemed in a transaction.

A PointsEvent may affect multiple points totals for a loyalty account. Additional totals (e.g., for clubs) are contained in the Collection accessible through the method getPointsTotals.


Method Summary
 java.util.Collection getAdditionalPointsTotals()
          Get any additional points totals for clubs or secondary accounts.
 java.lang.String getID()
          Returns a unique identifier of the points reward.
 java.lang.String getIDQualifier()
          Returns the points ID qualifier.
 java.lang.String getPoints()
          Returns the total points for the primary account.
 int getQuantity()
          Returns the points quantity as an integer value.
 java.lang.String getType()
          Returns the type of points (e.g., "primary").
 boolean isAwarded()
          Indicates if the points are awarded.
 boolean isRedeemed()
          Indicates if the points are redeemed.
 
Methods inherited from interface com.ibm.retail.AEF.event.LineItemEvent
getDescription, getItemModifier, getPrintLines, getRawPrintLines, isDeposit, isRefunded, isVoided
 
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

getType

public java.lang.String getType()
Returns the type of points (e.g., "primary").

Returns:
String - returns null if the property is undefined

getPoints

public java.lang.String getPoints()
Returns the total points for the primary account.

Returns:
string representation of the total number of points received - returns null if the property is undefined

getID

public java.lang.String getID()
Returns a unique identifier of the points reward.

Returns:
points ID - returns null if the property is undefined

getIDQualifier

public java.lang.String getIDQualifier()
Returns the points ID qualifier. The ID qualifier indicates the data format of the ID.

Returns:
points ID qualifer - returns null if the property is undefined

getQuantity

public int getQuantity()
                throws AEFException
Returns the points quantity as an integer value.

Returns:
the points quantity as an integer value.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

getAdditionalPointsTotals

public java.util.Collection getAdditionalPointsTotals()
Get any additional points totals for clubs or secondary accounts.

Returns:
Collection of PointsTotal objects (returns null if no totals)
See Also:
PointsTotal

isRedeemed

public boolean isRedeemed()
                   throws AEFException
Indicates if the points are redeemed. If not redeemed, then they are awarded.

Returns:
true if the points are redeemed
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isAwarded

public boolean isAwarded()
                  throws AEFException
Indicates if the points are awarded. If not awarded, then they are redeemed.

Returns:
true if the points are awarded.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE


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