com.ibm.retail.AEF.event
Interface TransactionDefinition

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

public interface TransactionDefinition
extends POSAppEventElement

A TransactionDefinition is a simple data object to contain information about POS transactions (Regular Sale, No Sale, COD,..).

The object contains indicators to determine what functions are valid for various transaction types.


Field Summary
static java.lang.String ALLOWANCES_ALLOWED
          Identifier for transaction allows allowances
static java.lang.String DISCOUNTS_ALLOWED
          Identifier for transaction allows discounts
static java.lang.String DOCUMENT_INSERT_USED
          Identifier for document insert used
static java.lang.String PAYMENTS_ALLOWED
          Identifier for transaction allows payments
static java.lang.String PROMPT_FOR_ACCOUNT_NUMBER
          Identifier for prompt for account number
static java.lang.String PROMPT_FOR_ORIGINAL_SALESPERSON
          Identifier for original sales person prompt
static java.lang.String PROMPT_FOR_TERMS_OF_SALE
          Identifier for terms of sale prompt
static java.lang.String RETURNS_ALLOWED
          Identifier for transaction allows returns
static java.lang.String SUSPEND_TRANSACTION_ALLOWED
          Identifier for suspend transaction allowed
static java.lang.String TRANSACTION_TYPE
          Identifier for transaction type (application specific, typically a short descriptor e.g., "noSale").
static java.lang.String VOID_TRANSACTION_ALLOWED
          Identifier for void transaction allowed
 
Method Summary
 boolean allowancesAllowed()
          Indicates if this transaction allows allowances to be applied.
 boolean discountsAllowed()
          Indicates if this transaction allows discounts to be applied.
 boolean documentInsertUsed()
          Indicates if this transaction requires a document insert.
 java.lang.String getType()
          Get the transaction type value.
 boolean paymentsAllowed()
          Indicates if this transaction allows payments.
 boolean promptForAccountNumber()
          Indicates if this transaction type requires an account number.
 boolean promptForOriginalSalesperson()
          Indicates if a prompt for original sales person is required.
 boolean promptForTermsOfSale()
          Indicates if a prompt for terms of sale is required.
 boolean returnsAllowed()
          Indicates if this transaction allows returns.
 boolean suspendTransactionAllowed()
          Indicates if suspend transaction is allowed.
 boolean voidTransactionAllowed()
          Indicates if void transaction is 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
 

Field Detail

TRANSACTION_TYPE

public static final java.lang.String TRANSACTION_TYPE
Identifier for transaction type (application specific, typically a short descriptor e.g., "noSale").

See Also:
Constant Field Values

PROMPT_FOR_ACCOUNT_NUMBER

public static final java.lang.String PROMPT_FOR_ACCOUNT_NUMBER
Identifier for prompt for account number

See Also:
Constant Field Values

DOCUMENT_INSERT_USED

public static final java.lang.String DOCUMENT_INSERT_USED
Identifier for document insert used

See Also:
Constant Field Values

PAYMENTS_ALLOWED

public static final java.lang.String PAYMENTS_ALLOWED
Identifier for transaction allows payments

See Also:
Constant Field Values

ALLOWANCES_ALLOWED

public static final java.lang.String ALLOWANCES_ALLOWED
Identifier for transaction allows allowances

See Also:
Constant Field Values

DISCOUNTS_ALLOWED

public static final java.lang.String DISCOUNTS_ALLOWED
Identifier for transaction allows discounts

See Also:
Constant Field Values

RETURNS_ALLOWED

public static final java.lang.String RETURNS_ALLOWED
Identifier for transaction allows returns

See Also:
Constant Field Values

PROMPT_FOR_ORIGINAL_SALESPERSON

public static final java.lang.String PROMPT_FOR_ORIGINAL_SALESPERSON
Identifier for original sales person prompt

See Also:
Constant Field Values

PROMPT_FOR_TERMS_OF_SALE

public static final java.lang.String PROMPT_FOR_TERMS_OF_SALE
Identifier for terms of sale prompt

See Also:
Constant Field Values

VOID_TRANSACTION_ALLOWED

public static final java.lang.String VOID_TRANSACTION_ALLOWED
Identifier for void transaction allowed

See Also:
Constant Field Values

SUSPEND_TRANSACTION_ALLOWED

public static final java.lang.String SUSPEND_TRANSACTION_ALLOWED
Identifier for suspend transaction allowed

See Also:
Constant Field Values
Method Detail

getType

public java.lang.String getType()
Get the transaction type value. Transaction types are application specific but are typically a short descriptor.

Returns:
the type of transaction

promptForAccountNumber

public boolean promptForAccountNumber()
                               throws AEFException
Indicates if this transaction type requires an account number.

Returns:
true if this transaction type requires an account number
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

documentInsertUsed

public boolean documentInsertUsed()
                           throws AEFException
Indicates if this transaction requires a document insert.

Returns:
true if this transaction requires a document insert.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

paymentsAllowed

public boolean paymentsAllowed()
                        throws AEFException
Indicates if this transaction allows payments.

Returns:
true if this transaction allows payments.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

allowancesAllowed

public boolean allowancesAllowed()
                          throws AEFException
Indicates if this transaction allows allowances to be applied.

Returns:
true if this transaction allows allowances to be applied.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

discountsAllowed

public boolean discountsAllowed()
                         throws AEFException
Indicates if this transaction allows discounts to be applied.

Returns:
true if this transaction allows discounts to be applied.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

returnsAllowed

public boolean returnsAllowed()
                       throws AEFException
Indicates if this transaction allows returns.

Returns:
true if this transaction allows returns.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

promptForOriginalSalesperson

public boolean promptForOriginalSalesperson()
                                     throws AEFException
Indicates if a prompt for original sales person is required.

Returns:
true if a prompt for original sales person is required.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

promptForTermsOfSale

public boolean promptForTermsOfSale()
                             throws AEFException
Indicates if a prompt for terms of sale is required.

Returns:
true if a prompt for terms of sale is required.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

voidTransactionAllowed

public boolean voidTransactionAllowed()
                               throws AEFException
Indicates if void transaction is allowed.

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

suspendTransactionAllowed

public boolean suspendTransactionAllowed()
                                  throws AEFException
Indicates if suspend transaction is allowed.

Returns:
true if suspend transaction is allowed.
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