com.ibm.retail.AEF.event
Interface CustomerEvent

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

public interface CustomerEvent
extends POSAppEvent

A CustomerEvent is generated when a customer is identified by scanning or swiping a customer identification or loyalty card. The CustomerEvent contains information about the customer defined for the current transaction.


Method Summary
 java.lang.String getAddress1()
          Get address line 1 of this Customer.
 java.lang.String getAddress2()
          Get address line 2 of this Customer.
 java.lang.String getCity()
          Returns the city of this Customer.
 java.lang.String getContact()
          Returns the contact number of this Customer.
 java.lang.String getEmail()
          Returns the email address of this Customer.
 java.lang.String getFax()
          Returns the fax number of this Customer.
 java.lang.String getID()
          Returns the ID of this customer (Customer Loyalty Number).
 java.lang.String getIDExpirationDate()
          Returns the ID expiration date.
 java.lang.String getIDType()
          Returns the ID type ('primary' or 'alternate').
 java.util.Collection getMessages()
          Returns all loyalty messages generated for this customer.
 java.lang.String getName()
          Returns the full name of this Customer.
 java.lang.String getPhone()
          Returns the phone number of this Customer.
 java.util.Collection getPointsBalances()
          Returns list of the points balances for all accounts and clubs.
 java.util.Collection getPointsTotals()
          Returns list of the points totals for all accounts and clubs.
 java.lang.String getState()
          Returns the state of this Customer.
 java.util.Collection getTargetedCoupons()
          Returns list of targeted coupons.
 java.lang.String getYTDPoints()
          Returns the year-to-date points of this Customer.
 java.lang.String getYTDSaved()
          Returns the year-to-date savings of this Customer.
 java.lang.String getZip()
          Returns the zipcode of this Customer.
 
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

getID

public java.lang.String getID()
Returns the ID of this customer (Customer Loyalty Number).

Returns:
customer ID - null if the property is undefined in this event

getIDType

public java.lang.String getIDType()
Returns the ID type ('primary' or 'alternate').

Returns:
ID type - null if the property is undefined in this event

getIDExpirationDate

public java.lang.String getIDExpirationDate()
Returns the ID expiration date.

Returns:
string representation of expiration date - null if the property is undefined in this event

getName

public java.lang.String getName()
Returns the full name of this Customer.

Returns:
customer full name - null if the property is undefined in this event

getAddress1

public java.lang.String getAddress1()
Get address line 1 of this Customer.

Returns:
address1 - null if the property is undefined in this event

getAddress2

public java.lang.String getAddress2()
Get address line 2 of this Customer.

Returns:
address2 - null if the property is undefined in this event

getCity

public java.lang.String getCity()
Returns the city of this Customer.

Returns:
city - null if the property is undefined in this event

getState

public java.lang.String getState()
Returns the state of this Customer.

Returns:
state - null if the property is undefined in this event

getZip

public java.lang.String getZip()
Returns the zipcode of this Customer.

Returns:
zipcode - null if the property is undefined in this event

getPhone

public java.lang.String getPhone()
Returns the phone number of this Customer.

Returns:
phone number - null if the property is undefined in this event

getContact

public java.lang.String getContact()
Returns the contact number of this Customer.

Returns:
contact name or number - null if the property is undefined in this event

getFax

public java.lang.String getFax()
Returns the fax number of this Customer.

Returns:
Fax number - null if the property is undefined in this event

getEmail

public java.lang.String getEmail()
Returns the email address of this Customer.

Returns:
email address - null if the property is undefined in this event

getYTDPoints

public java.lang.String getYTDPoints()
Returns the year-to-date points of this Customer.

Returns:
string representation of year-to-date points - null if the property is undefined in this event

getYTDSaved

public java.lang.String getYTDSaved()
Returns the year-to-date savings of this Customer.

Returns:
string representation of year-to-date savings - null if the property is undefined in this event

getTargetedCoupons

public java.util.Collection getTargetedCoupons()
Returns list of targeted coupons.

Returns:
Collection of strings defining coupon codes of targeted coupons. - null if the property is undefined in this event

getPointsTotals

public java.util.Collection getPointsTotals()
Returns list of the points totals for all accounts and clubs.

Returns:
Collection of PointsTotal objects - null if the property is undefined in this event
See Also:
PointsTotal

getPointsBalances

public java.util.Collection getPointsBalances()
Returns list of the points balances for all accounts and clubs.

Returns:
Collection of PointsTotal objects - null if the property is undefined in this event
See Also:
PointsTotal

getMessages

public java.util.Collection getMessages()
Returns all loyalty messages generated for this customer. Loyalty messages may be used to inform customer of loyalty account information.

Returns:
Collection of strings containing customer messages. - null if the property is undefined in this event


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