com.ibm.retail.AEF.event
Interface TenderDefinition

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

public interface TenderDefinition
extends POSAppEventElement

A TenderDefinition is a simple data object to contain information about POS tenders (Cash, Check, Credit,..). Includes the description and the POS keycode used to process the tender type.


Field Summary
static java.lang.String CAN_COUNT
          Property name identifier for: Indicates if this tender can be counted at this POS terminal
static java.lang.String CAN_LOAN
          Property name identifier for: Indicates if this tender can be loaned at this POS terminal
static java.lang.String CAN_PICKUP
          Property name identifier for: Indicates if this tender can be picked up at this POS terminal
static java.lang.String CAN_REFUND
          Property name identifier for: Indicates if this tender can be refunded at this POS terminal
static java.lang.String CAN_VERIFY
          Property name identifier for: Indicates if this tender can be verified at this POS terminal
static java.lang.String FOREIGN_TENDER
          Property name identifier for: Indicates if this tender is a foreign tender
static java.lang.String TENDER_ALLOWED
          Property name identifier for: Indicates if this tender is allowed at this POS terminal
static java.lang.String TENDER_DESCRIPTION
          Property name identifier for: Tender description is a textual description of the tender (e.g.
static java.lang.String TENDER_EXCHANGE_RANK
          Property name identifier for: Tender exchange rank is an application specified rank of the tender
static java.lang.String TENDER_KEY
          Property name identifier for: Tender key is the function code used for the tender on a POS keyboard
static java.lang.String TENDER_SHORT_DESCRIPTION
          Property name identifier for: Tender short description is an abbreviated description of the tender
static java.lang.String TENDER_TYPE
          Property name identifier for: Tender type as defined by the POS application, typically a 2-digit number
static java.lang.String TENDER_VARIETY
          Property name identifier for: Tender variety as defined by the POS application
 
Method Summary
 boolean canCount()
          Indicates if this tender be counted at this POS terminal.
 boolean canLoan()
          Indicates if this tender be loaned at this POS terminal
 boolean canPickUp()
          Indicates if this tender be picked up at this POS terminal
 boolean canRefund()
          Indicates if this tender be refunded at this POS terminal.
 boolean canVerify()
          Indicates if this tender be verified at this POS terminal.
 java.lang.String getDescription()
          Get the description.
 java.lang.String getKey()
          Get the tender key.
 java.lang.String getShortDescription()
          Get the tender short description.
 java.lang.String getTenderExchangeRank()
          Get the tender exchange rank.
 java.lang.String getType()
          Get the type value as defined by the POS application.
 java.lang.String getVariety()
          Get the tender variety.
 boolean isAllowed()
          Indicates if this is tender allowed at this POS terminal.
 boolean isForeignTender()
          Indicates if this is a foreign tender.
 
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
 

Field Detail

TENDER_TYPE

public static final java.lang.String TENDER_TYPE
Property name identifier for: Tender type as defined by the POS application, typically a 2-digit number

See Also:
Constant Field Values

TENDER_DESCRIPTION

public static final java.lang.String TENDER_DESCRIPTION
Property name identifier for: Tender description is a textual description of the tender (e.g. "CASH")

See Also:
Constant Field Values

TENDER_SHORT_DESCRIPTION

public static final java.lang.String TENDER_SHORT_DESCRIPTION
Property name identifier for: Tender short description is an abbreviated description of the tender

See Also:
Constant Field Values

TENDER_EXCHANGE_RANK

public static final java.lang.String TENDER_EXCHANGE_RANK
Property name identifier for: Tender exchange rank is an application specified rank of the tender

See Also:
Constant Field Values

TENDER_VARIETY

public static final java.lang.String TENDER_VARIETY
Property name identifier for: Tender variety as defined by the POS application

See Also:
Constant Field Values

TENDER_KEY

public static final java.lang.String TENDER_KEY
Property name identifier for: Tender key is the function code used for the tender on a POS keyboard

See Also:
Constant Field Values

FOREIGN_TENDER

public static final java.lang.String FOREIGN_TENDER
Property name identifier for: Indicates if this tender is a foreign tender

See Also:
Constant Field Values

TENDER_ALLOWED

public static final java.lang.String TENDER_ALLOWED
Property name identifier for: Indicates if this tender is allowed at this POS terminal

See Also:
Constant Field Values

CAN_LOAN

public static final java.lang.String CAN_LOAN
Property name identifier for: Indicates if this tender can be loaned at this POS terminal

See Also:
Constant Field Values

CAN_PICKUP

public static final java.lang.String CAN_PICKUP
Property name identifier for: Indicates if this tender can be picked up at this POS terminal

See Also:
Constant Field Values

CAN_COUNT

public static final java.lang.String CAN_COUNT
Property name identifier for: Indicates if this tender can be counted at this POS terminal

See Also:
Constant Field Values

CAN_REFUND

public static final java.lang.String CAN_REFUND
Property name identifier for: Indicates if this tender can be refunded at this POS terminal

See Also:
Constant Field Values

CAN_VERIFY

public static final java.lang.String CAN_VERIFY
Property name identifier for: Indicates if this tender can be verified at this POS terminal

See Also:
Constant Field Values
Method Detail

getType

public java.lang.String getType()
Get the type value as defined by the POS application. Type values are often numeric, (e.g., "1" for "CASH")

Returns:
tender type identifier

getDescription

public java.lang.String getDescription()
Get the description. The tender description is a textual desciption such as "CASH".

Returns:
tender description

getVariety

public java.lang.String getVariety()
Get the tender variety. Tender variety is application specific, and may be a numeric code to further identify the tender.

Returns:
tender variety

getKey

public java.lang.String getKey()
Get the tender key. The tender key identifies a key or function code on the POS keyboard used to identify the tender.

Returns:
tender key

getShortDescription

public java.lang.String getShortDescription()
Get the tender short description.

Returns:
short description

getTenderExchangeRank

public java.lang.String getTenderExchangeRank()
Get the tender exchange rank.

Returns:
tender exchange rank.

isForeignTender

public boolean isForeignTender()
                        throws AEFException
Indicates if this is a foreign tender.

Returns:
true if this is a foreign tender.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isAllowed

public boolean isAllowed()
                  throws AEFException
Indicates if this is tender allowed at this POS terminal.

Returns:
true if this is tender allowed at this POS terminal.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

canLoan

public boolean canLoan()
                throws AEFException
Indicates if this tender be loaned at this POS terminal

Returns:
true if this tender be loaned at this POS terminal
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

canPickUp

public boolean canPickUp()
                  throws AEFException
Indicates if this tender be picked up at this POS terminal

Returns:
true if this tender be picked up at this POS terminal
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

canCount

public boolean canCount()
                 throws AEFException
Indicates if this tender be counted at this POS terminal.

Returns:
true if this tender be counted at this POS terminal
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

canRefund

public boolean canRefund()
                  throws AEFException
Indicates if this tender be refunded at this POS terminal.

Returns:
true if this tender be refunded at this POS terminal
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

canVerify

public boolean canVerify()
                  throws AEFException
Indicates if this tender be verified at this POS terminal.

Returns:
true if this tender be verified at this POS terminal
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