com.ibm.retail.AEF.event
Interface TransactionStatusEvent

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

public interface TransactionStatusEvent
extends POSAppEvent

A TransactionStatusEvent is created when the status of a sales transaction is changed.

Status changes occur when a transaction starts and ends, or when the allowed actions for a transaction are updated (e.g., discount allowed).


Field Summary
static java.lang.String ALTERNATE_TAX_TYPE
          Transaction tax type: Tax type for "alternate tax" transaction tax changes
static java.lang.String CASH
          Transaction type identifier: Cash
static java.lang.String CASH_DOCUMENT
          Transaction type identifier: Cash Document transaction type.
static java.lang.String CASH_SPECIAL
          Transaction type identifier: Cash Special transaction type.
static java.lang.String CHARGE_PLAN_A
          Transaction type identifier: Charge Plan A transaction type.
static java.lang.String CHARGE_PLAN_B
          Transaction type identifier: Charge Plan B transaction type.
static java.lang.String CHARGE_PLAN_C
          Transaction type identifier: Charge Plan C transaction type.
static java.lang.String CHARGE_PLAN_D
          Transaction type identifier: Charge Plan D transaction type.
static java.lang.String COD
          Transaction type identifier: COD transaction type.
static java.lang.String DEPT_TOTALS_REPORT
          Transaction type identifier: Department Totals Report transaction type
static java.lang.String EBT_BALANCE_INQUIRY
          Transaction type identifier: EBT Balance Inquiry transaction type
static java.lang.String EFT_BALANACE_INQUIRY
          Transaction type identifier: EFT Balance Inquiry transaction type
static java.lang.String EXEMPT_TAX_TYPE
          Transaction tax type: "tax exempt" transaction tax changes
static java.lang.String ITEM_MOVEMENT_REPORT
          Transaction type identifier: Item Movement Report transaction type.
static java.lang.String ITEM_PRICE_CHANGE
          Transaction type identifier: Item Price Change transaction type.
static java.lang.String ITEM_RETURN
          Transaction type identifier: Item Return transaction type
static java.lang.String LAYAWAY
          Transaction type identifier: Layaway transaction type.
static java.lang.String LAYAWAY_CANCEL
          Transaction type identifier: Layaway Cancel transaction type
static java.lang.String LAYAWAY_PAYMENT
          Transaction type identifier: Layaway Payment transaction type
static java.lang.String LOAN
          Transaction type identifier: Loan transaction type.
static java.lang.String MANUAL_TAX_TYPE
          Transaction tax type: Tax type for "manual tax" transaction tax changes
static java.lang.String MODIFY_DEPT_PRESETS
          Transaction type identifier: Modify Department Presets transaction type
static java.lang.String NO_SALE
          Transaction type identifier: No Sale
static java.lang.String NONSALES_CATEGORY
          Transaction category: "nonsales" transactions
static java.lang.String NOSALE_PRICE_VERIFY
          Transaction type identifier: Nosale Price Verify transaction type
static java.lang.String OFFLINE_REENTRY
          Transaction type identifier: Offline Reentry transaction type.
static java.lang.String OPEN_TRANS_REPORT
          Transaction type identifier: Open Transaction Report transaction type
static java.lang.String PICKUP
          Transaction type identifier: Pickup transaction type.
static java.lang.String PRICE_CHANGE
          Transaction type identifier: Price Change transaction type
static java.lang.String PRICE_VERIFY
          Transaction type identifier: Price Verify transaction type
static java.lang.String QUERY_EXCHANGE_RATE
          Transaction type identifier: Query Exchange Rate transaction type.
static java.lang.String REGULAR_SALE
          Transaction type identifier: Regular Sale
static java.lang.String REGULAR_SALE_TRAINING
          Transaction type modifier: Regular Sale Training
static java.lang.String REPRINT_PARTIAL
          Transaction type identifier: Reprint Partial Receipt transaction type
static java.lang.String REPRINT_TENDER_RECEIPT
          Transaction type identifier: Reprint Tender Receipt transaction type
static java.lang.String SALES_CATEGORY
          Transaction category: "sales" transactions
static java.lang.String SET_TRANS_NUMBER
          Transaction type identifier: Set Transaction Number transaction type.
static java.lang.String SUSPENDED_TRANS_REPORT
          Transaction type identifier: Suspended Transaction Report transaction type
static java.lang.String TENDER_CASHING
          Transaction type identifier: Tender Cashing transaction type.
static java.lang.String TENDER_COUNT
          Transaction type identifier: Tender Count transaction type.
static java.lang.String TENDER_EXCHANGE
          Transaction type identifier: Tender Exchange transaction type
static java.lang.String TENDER_FEE_REFUND
          Transaction type identifier: Tender Fee Refund transaction type
static java.lang.String TENDER_LIST_REPORT
          Transaction type identifier: Tender Listing Report transaction type.
static java.lang.String TENDER_REMOVAL
          Transaction type identifier: Tender Removal transaction type.
static java.lang.String TERMINAL_MONITOR
          Transaction type identifier: Terminal Monitor transaction type.
static java.lang.String TERMINAL_PROGRAM_LOAD
          Transaction type identifier: Terminal Program Load transaction type
static java.lang.String TERMINAL_TRANSFER
          Transaction type identifier: Terminal Transfer transaction type
static java.lang.String TILL_EXCHANGE
          Transaction type identifier: Till Exchange transaction type
static java.lang.String TILL_REPORT
          Transaction type identifier: Till Report transaction type
static java.lang.String TOTALS_READOUT_RESET
          Transaction type identifier: Totals Readout Reset transaction type.
static java.lang.String TRAINING
          Transaction type identifier: Training transaction type.
static java.lang.String TRANSACTION_END
          Event type identifier: transaction ended.
static java.lang.String TRANSACTION_START
          Event type identifier: transaction started.
static java.lang.String TRANSACTION_SUSPEND
          Event type identifier: transaction suspended.
static java.lang.String TRANSACTION_TAX_CHANGE
          Event type identifier: transaction tax change.
static java.lang.String TRANSACTION_UPDATE
          Event type identifier: transaction status updated.
static java.lang.String TRANSACTION_VOID
          Event type identifier: transaction voided.
static java.lang.String VALUE_CARD_BAL_INQUIRY
          Transaction type identifier: Value Card Balance Inquiry transaction type
static java.lang.String VERIFY_TENDER
          Transaction type identifier: Verify Tender transaction type
static java.lang.String VOID_PREVIOUS_BY_LINE
          Transaction type identifier: Void Previous By Line Item transaction type.
static java.lang.String VOID_PREVIOUS_TRANS
          Transaction type identifier: Void Previous Transaction transaction type.
static java.lang.String WIC
          Transaction type identifier: WIC transaction type
 
Method Summary
 boolean cancelAllItems()
          For "layaway cancel" transactions, indicates if the cancel applies to all items.
 java.lang.String getAccountNumber()
          Get the account number for this transaction.
 java.lang.String getCategory()
          Get the transaction category identifier (sales/nonsales).
 java.lang.String getDate()
          Get the transaction date.
 java.lang.String getID()
          Get the transaction identifier.
 java.lang.String getModifier()
          Get the transaction modifier (used for additional transaction information).
 java.lang.String getTaxReason()
          Get the Tax Reason (tax code or discount group).
 java.lang.String getTaxType()
          Get the Tax Type (exempt, manual, alternate).
 java.lang.String getTime()
          Get the transaction time.
 java.lang.String getType()
          Get the transaction type.
 boolean isItemAllowanceAllowed()
          Indicates if an item allowance is allowed for this transaction.
 boolean isItemDiscountAllowed()
          Indicates if an item discount is allowed for this transaction.
 boolean isTaxChangeVoided()
          Indicates if this tax change is voided for this transaction.
 boolean isTransactionDiscountAllowed()
          Indicates if a transaction discount is allowed for this transaction.
 boolean isVoidLineItemAllowed()
          Indicates if a void line item is allowed for this transaction.
 boolean returnPayments()
          For "layaway cancel" transactions, indicates if payments are returned to the 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
 

Field Detail

TRANSACTION_START

public static final java.lang.String TRANSACTION_START
Event type identifier: transaction started.

See Also:
POSAppEvent.getEventType(), Constant Field Values

TRANSACTION_END

public static final java.lang.String TRANSACTION_END
Event type identifier: transaction ended.

See Also:
POSAppEvent.getEventType(), Constant Field Values

TRANSACTION_VOID

public static final java.lang.String TRANSACTION_VOID
Event type identifier: transaction voided.

See Also:
POSAppEvent.getEventType(), Constant Field Values

TRANSACTION_SUSPEND

public static final java.lang.String TRANSACTION_SUSPEND
Event type identifier: transaction suspended.

See Also:
POSAppEvent.getEventType(), Constant Field Values

TRANSACTION_UPDATE

public static final java.lang.String TRANSACTION_UPDATE
Event type identifier: transaction status updated.

See Also:
POSAppEvent.getEventType(), Constant Field Values

TRANSACTION_TAX_CHANGE

public static final java.lang.String TRANSACTION_TAX_CHANGE
Event type identifier: transaction tax change.

See Also:
POSAppEvent.getEventType(), Constant Field Values

REGULAR_SALE

public static final java.lang.String REGULAR_SALE
Transaction type identifier: Regular Sale

See Also:
getType(), Constant Field Values

NO_SALE

public static final java.lang.String NO_SALE
Transaction type identifier: No Sale

See Also:
getType(), Constant Field Values

CASH

public static final java.lang.String CASH
Transaction type identifier: Cash

See Also:
getType(), Constant Field Values

CASH_SPECIAL

public static final java.lang.String CASH_SPECIAL
Transaction type identifier: Cash Special transaction type.

See Also:
getType(), Constant Field Values

CASH_DOCUMENT

public static final java.lang.String CASH_DOCUMENT
Transaction type identifier: Cash Document transaction type.

See Also:
getType(), Constant Field Values

COD

public static final java.lang.String COD
Transaction type identifier: COD transaction type.

See Also:
getType(), Constant Field Values

LAYAWAY

public static final java.lang.String LAYAWAY
Transaction type identifier: Layaway transaction type.

See Also:
getType(), Constant Field Values

CHARGE_PLAN_A

public static final java.lang.String CHARGE_PLAN_A
Transaction type identifier: Charge Plan A transaction type.

See Also:
getType(), Constant Field Values

CHARGE_PLAN_B

public static final java.lang.String CHARGE_PLAN_B
Transaction type identifier: Charge Plan B transaction type.

See Also:
getType(), Constant Field Values

CHARGE_PLAN_C

public static final java.lang.String CHARGE_PLAN_C
Transaction type identifier: Charge Plan C transaction type.

See Also:
getType(), Constant Field Values

CHARGE_PLAN_D

public static final java.lang.String CHARGE_PLAN_D
Transaction type identifier: Charge Plan D transaction type.

See Also:
getType(), Constant Field Values

LOAN

public static final java.lang.String LOAN
Transaction type identifier: Loan transaction type.

See Also:
getType(), Constant Field Values

PICKUP

public static final java.lang.String PICKUP
Transaction type identifier: Pickup transaction type.

See Also:
getType(), Constant Field Values

TENDER_COUNT

public static final java.lang.String TENDER_COUNT
Transaction type identifier: Tender Count transaction type.

See Also:
getType(), Constant Field Values

TOTALS_READOUT_RESET

public static final java.lang.String TOTALS_READOUT_RESET
Transaction type identifier: Totals Readout Reset transaction type.

See Also:
getType(), Constant Field Values

ITEM_MOVEMENT_REPORT

public static final java.lang.String ITEM_MOVEMENT_REPORT
Transaction type identifier: Item Movement Report transaction type.

See Also:
getType(), Constant Field Values

ITEM_PRICE_CHANGE

public static final java.lang.String ITEM_PRICE_CHANGE
Transaction type identifier: Item Price Change transaction type.

See Also:
getType(), Constant Field Values

SET_TRANS_NUMBER

public static final java.lang.String SET_TRANS_NUMBER
Transaction type identifier: Set Transaction Number transaction type.

See Also:
getType(), Constant Field Values

OFFLINE_REENTRY

public static final java.lang.String OFFLINE_REENTRY
Transaction type identifier: Offline Reentry transaction type.

See Also:
getType(), Constant Field Values

TRAINING

public static final java.lang.String TRAINING
Transaction type identifier: Training transaction type.

See Also:
getType(), Constant Field Values

VOID_PREVIOUS_TRANS

public static final java.lang.String VOID_PREVIOUS_TRANS
Transaction type identifier: Void Previous Transaction transaction type.

See Also:
getType(), Constant Field Values

VOID_PREVIOUS_BY_LINE

public static final java.lang.String VOID_PREVIOUS_BY_LINE
Transaction type identifier: Void Previous By Line Item transaction type.

See Also:
getType(), Constant Field Values

TENDER_LIST_REPORT

public static final java.lang.String TENDER_LIST_REPORT
Transaction type identifier: Tender Listing Report transaction type.

See Also:
getType(), Constant Field Values

TENDER_REMOVAL

public static final java.lang.String TENDER_REMOVAL
Transaction type identifier: Tender Removal transaction type.

See Also:
getType(), Constant Field Values

TERMINAL_MONITOR

public static final java.lang.String TERMINAL_MONITOR
Transaction type identifier: Terminal Monitor transaction type.

See Also:
getType(), Constant Field Values

QUERY_EXCHANGE_RATE

public static final java.lang.String QUERY_EXCHANGE_RATE
Transaction type identifier: Query Exchange Rate transaction type.

See Also:
getType(), Constant Field Values

TENDER_CASHING

public static final java.lang.String TENDER_CASHING
Transaction type identifier: Tender Cashing transaction type.

See Also:
getType(), Constant Field Values

TENDER_EXCHANGE

public static final java.lang.String TENDER_EXCHANGE
Transaction type identifier: Tender Exchange transaction type

See Also:
getType(), Constant Field Values

PRICE_VERIFY

public static final java.lang.String PRICE_VERIFY
Transaction type identifier: Price Verify transaction type

See Also:
getType(), Constant Field Values

TERMINAL_TRANSFER

public static final java.lang.String TERMINAL_TRANSFER
Transaction type identifier: Terminal Transfer transaction type

See Also:
getType(), Constant Field Values

TERMINAL_PROGRAM_LOAD

public static final java.lang.String TERMINAL_PROGRAM_LOAD
Transaction type identifier: Terminal Program Load transaction type

See Also:
getType(), Constant Field Values

ITEM_RETURN

public static final java.lang.String ITEM_RETURN
Transaction type identifier: Item Return transaction type

See Also:
getType(), Constant Field Values

WIC

public static final java.lang.String WIC
Transaction type identifier: WIC transaction type

See Also:
getType(), Constant Field Values

REPRINT_PARTIAL

public static final java.lang.String REPRINT_PARTIAL
Transaction type identifier: Reprint Partial Receipt transaction type

See Also:
getType(), Constant Field Values

REPRINT_TENDER_RECEIPT

public static final java.lang.String REPRINT_TENDER_RECEIPT
Transaction type identifier: Reprint Tender Receipt transaction type

See Also:
getType(), Constant Field Values

EBT_BALANCE_INQUIRY

public static final java.lang.String EBT_BALANCE_INQUIRY
Transaction type identifier: EBT Balance Inquiry transaction type

See Also:
getType(), Constant Field Values

VALUE_CARD_BAL_INQUIRY

public static final java.lang.String VALUE_CARD_BAL_INQUIRY
Transaction type identifier: Value Card Balance Inquiry transaction type

See Also:
getType(), Constant Field Values

DEPT_TOTALS_REPORT

public static final java.lang.String DEPT_TOTALS_REPORT
Transaction type identifier: Department Totals Report transaction type

See Also:
getType(), Constant Field Values

LAYAWAY_PAYMENT

public static final java.lang.String LAYAWAY_PAYMENT
Transaction type identifier: Layaway Payment transaction type

See Also:
getType(), Constant Field Values

LAYAWAY_CANCEL

public static final java.lang.String LAYAWAY_CANCEL
Transaction type identifier: Layaway Cancel transaction type

See Also:
getType(), Constant Field Values

PRICE_CHANGE

public static final java.lang.String PRICE_CHANGE
Transaction type identifier: Price Change transaction type

See Also:
getType(), Constant Field Values

TENDER_FEE_REFUND

public static final java.lang.String TENDER_FEE_REFUND
Transaction type identifier: Tender Fee Refund transaction type

See Also:
getType(), Constant Field Values

SUSPENDED_TRANS_REPORT

public static final java.lang.String SUSPENDED_TRANS_REPORT
Transaction type identifier: Suspended Transaction Report transaction type

See Also:
getType(), Constant Field Values

MODIFY_DEPT_PRESETS

public static final java.lang.String MODIFY_DEPT_PRESETS
Transaction type identifier: Modify Department Presets transaction type

See Also:
getType(), Constant Field Values

OPEN_TRANS_REPORT

public static final java.lang.String OPEN_TRANS_REPORT
Transaction type identifier: Open Transaction Report transaction type

See Also:
getType(), Constant Field Values

EFT_BALANACE_INQUIRY

public static final java.lang.String EFT_BALANACE_INQUIRY
Transaction type identifier: EFT Balance Inquiry transaction type

See Also:
getType(), Constant Field Values

TILL_EXCHANGE

public static final java.lang.String TILL_EXCHANGE
Transaction type identifier: Till Exchange transaction type

See Also:
getType(), Constant Field Values

VERIFY_TENDER

public static final java.lang.String VERIFY_TENDER
Transaction type identifier: Verify Tender transaction type

See Also:
getType(), Constant Field Values

TILL_REPORT

public static final java.lang.String TILL_REPORT
Transaction type identifier: Till Report transaction type

See Also:
getType(), Constant Field Values

NOSALE_PRICE_VERIFY

public static final java.lang.String NOSALE_PRICE_VERIFY
Transaction type identifier: Nosale Price Verify transaction type

See Also:
getType(), Constant Field Values

REGULAR_SALE_TRAINING

public static final java.lang.String REGULAR_SALE_TRAINING
Transaction type modifier: Regular Sale Training

See Also:
getModifier(), Constant Field Values

SALES_CATEGORY

public static final java.lang.String SALES_CATEGORY
Transaction category: "sales" transactions

See Also:
getCategory(), Constant Field Values

NONSALES_CATEGORY

public static final java.lang.String NONSALES_CATEGORY
Transaction category: "nonsales" transactions

See Also:
getCategory(), Constant Field Values

EXEMPT_TAX_TYPE

public static final java.lang.String EXEMPT_TAX_TYPE
Transaction tax type: "tax exempt" transaction tax changes

See Also:
getTaxType(), Constant Field Values

ALTERNATE_TAX_TYPE

public static final java.lang.String ALTERNATE_TAX_TYPE
Transaction tax type: Tax type for "alternate tax" transaction tax changes

See Also:
getTaxType(), Constant Field Values

MANUAL_TAX_TYPE

public static final java.lang.String MANUAL_TAX_TYPE
Transaction tax type: Tax type for "manual tax" transaction tax changes

See Also:
getTaxType(), Constant Field Values
Method Detail

getID

public java.lang.String getID()
Get the transaction identifier.

Returns:
a string representation of the transaction number

getDate

public java.lang.String getDate()
Get the transaction date.

Returns:
a string representation of the transaction date (format: YYMMDD)

getModifier

public java.lang.String getModifier()
Get the transaction modifier (used for additional transaction information).

Returns:
String

getCategory

public java.lang.String getCategory()
Get the transaction category identifier (sales/nonsales).

Returns:
transaction category (sales or nonsales). Among the possible values are:
TransactionStatusEvent.SALES_CATEGORY
TransactionStatusEvent.NOSALES_CATEGORY

getType

public java.lang.String getType()
Get the transaction type.

Transaction types include cash, loan, pickup. The list of identifiers for transaction types are defined in this interface (See field identifiers labeled "Transaction type identifier").

Returns:
type of transaction. Among the possible values are:
TransactionStatusEvent.CASH
TransactionStatusEvent.NO_SALE

getTime

public java.lang.String getTime()
Get the transaction time.

Returns:
a string representation of the transaction time (format: HH:MM)

getAccountNumber

public java.lang.String getAccountNumber()
Get the account number for this transaction.

Typically only used for layaway or "charge plan" transactions. Account numbers for credit/debit are entered during tendering and are not passed through this event.

Returns:
account number

returnPayments

public boolean returnPayments()
                       throws AEFException
For "layaway cancel" transactions, indicates if payments are returned to the customer.

Returns:
true if payments are returned to the customer
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

cancelAllItems

public boolean cancelAllItems()
                       throws AEFException
For "layaway cancel" transactions, indicates if the cancel applies to all items.

Returns:
true if cancel applies to all items.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isItemAllowanceAllowed

public boolean isItemAllowanceAllowed()
                               throws AEFException
Indicates if an item allowance is allowed for this transaction.

Returns:
true if an item allowance is allowed for this transaction.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isItemDiscountAllowed

public boolean isItemDiscountAllowed()
                              throws AEFException
Indicates if an item discount is allowed for this transaction.

Returns:
true if an item discount is allowed for this transaction.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isTransactionDiscountAllowed

public boolean isTransactionDiscountAllowed()
                                     throws AEFException
Indicates if a transaction discount is allowed for this transaction.

Returns:
true if a transaction discount is allowed for this transaction.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isVoidLineItemAllowed

public boolean isVoidLineItemAllowed()
                              throws AEFException
Indicates if a void line item is allowed for this transaction.

Returns:
true if a void line item allowed for this transaction.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

getTaxType

public java.lang.String getTaxType()
Get the Tax Type (exempt, manual, alternate). (Valid for transaction tax change events only)

Returns:
identifier of tax type. Among the possible values are:
TransactionStatusEvent.EXEMPT_TAX_TYPE
TransactionStatusEvent.ALTERNATE_TAX_TYPE
TransactionStatusEvent.MANUAL_TAX_TYPE

getTaxReason

public java.lang.String getTaxReason()
Get the Tax Reason (tax code or discount group). (Valid for transaction tax change events only)

Returns:
string representation or identifier of the tax reason.

isTaxChangeVoided

public boolean isTaxChangeVoided()
                          throws AEFException
Indicates if this tax change is voided for this transaction. (Valid for transaction tax change events only)

Returns:
boolean
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