A B C D E F G H I K L M P R S T U V

A

addException(Object, Throwable) - Method in class com.ibm.retail.saf.provider.POSResultImpl
 
addItem(ItemIdentifier) - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
 
addItem(ItemIdentifier) - Method in interface com.ibm.retail.saf.provider.PriceRequest
Adds an ItemIdentifier to the request.
addLegalText(String) - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
Add legal text
addLineItem(LineItem) - Method in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
addLineItem(LineItem) - Method in interface com.ibm.retail.saf.provider.TransactionRequest
Adds a LineItem to the request.
addPrice(ItemIdentifier, PriceInfo) - Method in class com.ibm.retail.saf.provider.DefaultPriceResult
 
addPrintLine(PrintLine) - Method in class com.ibm.retail.saf.provider.Default4690CashReceipt
 
addReceiptLineItem(ReceiptLineItem) - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
alternateLoyaltyID - Variable in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
AMEX - Static variable in interface com.ibm.retail.saf.provider.CreditPaymentInfo
American express credit card type identifier
ApplicationException - exception com.ibm.retail.saf.provider.ApplicationException.
An ApplicationException is thrown when the point-of-sale system encounters an error attempting to process a request from the client.
ApplicationException() - Constructor for class com.ibm.retail.saf.provider.ApplicationException
 
ApplicationException(String) - Constructor for class com.ibm.retail.saf.provider.ApplicationException
 
ApplicationException(String, Throwable) - Constructor for class com.ibm.retail.saf.provider.ApplicationException
 
ApplicationException(Throwable) - Constructor for class com.ibm.retail.saf.provider.ApplicationException
 
approvalCode - Variable in class com.ibm.retail.saf.provider.DefaultPaymentResult
 

B

balanceDue - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 

C

cancel() - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Cancels the transaction.
cancel() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
CARTE_BLANCHE - Static variable in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Mastercard credit card type identifier
cashReceipt - Variable in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
cashReceiptImage - Variable in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
CashReceiptImage - interface com.ibm.retail.saf.provider.CashReceiptImage.
Provides an image of the point-of-sale register cash receipt.
centered - Variable in class com.ibm.retail.saf.provider.Default4690PrintLine
 
changeDue - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
clientID - Variable in class com.ibm.retail.saf.provider.POSRequestImpl
 
clientTransactionNumber - Variable in class com.ibm.retail.saf.provider.DefaultTransactionID
 
com.ibm.retail.saf.provider - package com.ibm.retail.saf.provider
Provides client interface for sending requests to a point-of-sale system.
com.ibm.retail.saf.provider.kiosk - package com.ibm.retail.saf.provider.kiosk
Provides client interfaces and implementations needed to satisfy basic kiosk access to the point-of-sale system.
confirm() - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Provides confirmation that the client has received the results from a point-of-sale transaction request.
confirm() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
CONFIRMED - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
correlatorID - Variable in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
couponCount - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
CREDIT - Static variable in interface com.ibm.retail.saf.provider.PaymentInfo
Credit payment
CreditCard - class com.ibm.retail.saf.provider.CreditCard.
Contains information required to process a credit card payment.
CreditCard() - Constructor for class com.ibm.retail.saf.provider.CreditCard
 
CreditPaymentInfo - interface com.ibm.retail.saf.provider.CreditPaymentInfo.
Contains the credit card information needed to tender payment at the point-of-sale system.
customerLoyaltyID - Variable in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
cut - Variable in class com.ibm.retail.saf.provider.Default4690PrintLine
 

D

DEBIT - Static variable in interface com.ibm.retail.saf.provider.PaymentInfo
Debit payment
Default4690CashReceipt - class com.ibm.retail.saf.provider.Default4690CashReceipt.
Image of cash receipt from an IBM 4690 POS terminal.
Default4690CashReceipt() - Constructor for class com.ibm.retail.saf.provider.Default4690CashReceipt
 
Default4690PrintLine - class com.ibm.retail.saf.provider.Default4690PrintLine.
Base implementation of PrintLine
Default4690PrintLine() - Constructor for class com.ibm.retail.saf.provider.Default4690PrintLine
Constructor
Default4690PrintLine(String, String, int, boolean, int) - Constructor for class com.ibm.retail.saf.provider.Default4690PrintLine
Constructor
DefaultLineItem - class com.ibm.retail.saf.provider.DefaultLineItem.
Provides item and quantity information for an item.
DefaultLineItem() - Constructor for class com.ibm.retail.saf.provider.DefaultLineItem
 
DefaultLineItem(String, String) - Constructor for class com.ibm.retail.saf.provider.DefaultLineItem
 
DefaultLogRequest - class com.ibm.retail.saf.provider.DefaultLogRequest.
Provides information needed to log an exception in the point-of-sale exception log.
DefaultLogRequest() - Constructor for class com.ibm.retail.saf.provider.DefaultLogRequest
 
DefaultPaymentRequest - class com.ibm.retail.saf.provider.DefaultPaymentRequest.
Provides a base implementation of a PaymentRequest.
DefaultPaymentRequest() - Constructor for class com.ibm.retail.saf.provider.DefaultPaymentRequest
 
DefaultPaymentResult - class com.ibm.retail.saf.provider.DefaultPaymentResult.
Provides a base implementation of a PaymentResult.
DefaultPaymentResult() - Constructor for class com.ibm.retail.saf.provider.DefaultPaymentResult
Default constructor
DefaultPaymentResult(String, String, String, String, String, List) - Constructor for class com.ibm.retail.saf.provider.DefaultPaymentResult
Constructor.
DefaultPOSRequestFactory - class com.ibm.retail.saf.provider.DefaultPOSRequestFactory.
Provides an base implementation of POSRequestFactory.
DefaultPOSRequestFactory() - Constructor for class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
Construct factory.
DefaultPriceInfo - class com.ibm.retail.saf.provider.DefaultPriceInfo.
Contains price information about an item in the point-of-sale system.
DefaultPriceInfo() - Constructor for class com.ibm.retail.saf.provider.DefaultPriceInfo
Construct a PriceInfo object with no attributes.
DefaultPriceInfo(ItemIdentifier, String, String) - Constructor for class com.ibm.retail.saf.provider.DefaultPriceInfo
Construct a PriceInfo object with a price, description, and unit price.
DefaultPriceRequest - class com.ibm.retail.saf.provider.DefaultPriceRequest.
Provides a list of item numbers and qualifying information needed to determine unit price information for the list of items.
DefaultPriceRequest() - Constructor for class com.ibm.retail.saf.provider.DefaultPriceRequest
Constructs a PriceRequest with an empty list of items.
DefaultPriceResult - class com.ibm.retail.saf.provider.DefaultPriceResult.
Contains the results obtained from performing a price lookup on the point-of-sale system.
DefaultPriceResult() - Constructor for class com.ibm.retail.saf.provider.DefaultPriceResult
 
DefaultProviderRequest - class com.ibm.retail.saf.provider.DefaultProviderRequest.
Provides a base implementation of a ProviderRequest.
DefaultProviderRequest() - Constructor for class com.ibm.retail.saf.provider.DefaultProviderRequest
 
DefaultReceiptLineItem - class com.ibm.retail.saf.provider.DefaultReceiptLineItem.
Implements the ReceiptLineItem interface.
DefaultReceiptLineItem() - Constructor for class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
DefaultTransactionID - class com.ibm.retail.saf.provider.DefaultTransactionID.
Provides a base implementation of a TransactionID.
DefaultTransactionID() - Constructor for class com.ibm.retail.saf.provider.DefaultTransactionID
 
DefaultTransactionRequest - class com.ibm.retail.saf.provider.DefaultTransactionRequest.
Provides item information to a point-of-sale transaction.
DefaultTransactionRequest() - Constructor for class com.ibm.retail.saf.provider.DefaultTransactionRequest
Default constructor
DefaultTransactionResult - class com.ibm.retail.saf.provider.DefaultTransactionResult.
Contains the results of processing a point-of-sale transaction.
DefaultTransactionResult() - Constructor for class com.ibm.retail.saf.provider.DefaultTransactionResult
 
DefaultTransactionTotals - class com.ibm.retail.saf.provider.DefaultTransactionTotals.
Provides a base implementation of a TransactionTotals.
DefaultTransactionTotals() - Constructor for class com.ibm.retail.saf.provider.DefaultTransactionTotals
Constructor
DefaultTransactionTotals(String, String, String, String, String, String, String, String) - Constructor for class com.ibm.retail.saf.provider.DefaultTransactionTotals
Constructor for setting all data variables at once
description - Variable in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
DINERS_CLUB - Static variable in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Diners club credit card type identifier
DISCOUNT_PRICE - Static variable in interface com.ibm.retail.saf.provider.PriceRequest
Used to specify a price request for the discounted unit price.
DISCOVER - Static variable in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Discover card credit card type identifier

E

equals(Object) - Method in class com.ibm.retail.saf.provider.ScannedItemIdentifier
Returns true if the item code and type are the same.
exceptionsMap - Variable in class com.ibm.retail.saf.provider.POSResultImpl
 
extendedPrice - Variable in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 

F

font - Variable in class com.ibm.retail.saf.provider.Default4690PrintLine
 
FONT_BOLD - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 
FONT_DOUBLE_WIDE - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 
FONT_DOUBLE_WIDE_BOLD - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 
FONT_DOUBLE_WIDE_DOUBLE_HIGH - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 
FONT_DOUBLE_WIDE_DOUBLE_HIGH_BOLD - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 
FONT_MEDIUM - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 
FONT_MEDIUM_WIDE_BOLD - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 
FONT_NORMAL - Static variable in interface com.ibm.retail.saf.provider.PrintLine
 

G

getAccountNumber() - Method in class com.ibm.retail.saf.provider.CreditCard
 
getAccountNumber() - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Gets the account number.
getAlternateLoyaltyID() - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
Gets the alternate loyalty or customer number defined for this price request.
getAlternateLoyaltyID() - Method in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
getAlternateLoyaltyID() - Method in interface com.ibm.retail.saf.provider.PriceRequest
Gets the alternate loyalty or customer number defined for this price request.
getAlternateLoyaltyID() - Method in interface com.ibm.retail.saf.provider.TransactionRequest
Gets the alternate loyalty or customer number defined for this transaction.
getApprovalCode() - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
getApprovalCode() - Method in interface com.ibm.retail.saf.provider.PaymentResult
Gets the EFT approval code
getAttribute(String) - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
getAttributeNames() - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
getBalanceDue() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getBalanceDue() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the balance due.
getBaseItemPrices(PriceRequest) - Method in interface com.ibm.retail.saf.provider.PriceChecker
Sends a request to the point-of-sale system to obtain the current unit sales price for a list of items.
getBaseItemPrices(PriceRequest) - Method in interface com.ibm.retail.saf.provider.PriceProvider
Sends a request to the point-of-sale system to obtain the current unit sales price for a list of items.
getBaseItemPrices(PriceRequest) - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
 
getCardType() - Method in class com.ibm.retail.saf.provider.CreditCard
 
getCardType() - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Gets the card type.
getCashReceiptImage() - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
getCashReceiptImage() - Method in interface com.ibm.retail.saf.provider.Transaction
Get the image of the point-of-sale cash receipt produced by the transaction.
getCashReceiptImage() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
getChangeDue() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getChangeDue() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the change due.
getClientID() - Method in interface com.ibm.retail.saf.provider.POSRequest
Gets the optional client identifier.
getClientID() - Method in class com.ibm.retail.saf.provider.POSRequestImpl
 
getClientTransactionNumber() - Method in class com.ibm.retail.saf.provider.DefaultTransactionID
 
getClientTransactionNumber() - Method in interface com.ibm.retail.saf.provider.TransactionID
Returns a unique ID assigned to the transaction started by the client This ID is used by the POSProvider to track the results of point-of-sale transactions.
getCouponCount() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getCouponCount() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the coupon count .
getCustomerLoyaltyID() - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
Gets the customer's loyalty identifier defined for this price request.
getCustomerLoyaltyID() - Method in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
getCustomerLoyaltyID() - Method in interface com.ibm.retail.saf.provider.PriceRequest
Gets the customer's loyalty identifier defined for this price request.
getCustomerLoyaltyID() - Method in interface com.ibm.retail.saf.provider.TransactionRequest
Gets the customer's loyalty identifier defined for this transaction.
getDescription() - Method in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
getDescription() - Method in interface com.ibm.retail.saf.provider.ReceiptLineItem
Get the description of the item.
getExceptions() - Method in interface com.ibm.retail.saf.provider.POSResult
Return an iterator of non-fatal exceptions that are contained in the result.
getExceptions() - Method in class com.ibm.retail.saf.provider.POSResultImpl
 
getExpirationDate() - Method in class com.ibm.retail.saf.provider.CreditCard
 
getExpirationDate() - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Gets the expiration date.
getExtendedAttribute(String) - Method in interface com.ibm.retail.saf.provider.POSInfo
Returns the value of an extended attribute as an Object or null if the attribute is undefined.
getExtendedAttribute(String) - Method in class com.ibm.retail.saf.provider.POSInfoImpl
 
getExtendedAttributeNames() - Method in interface com.ibm.retail.saf.provider.POSInfo
Returns an enumeration of the extended attribute names in this request.
getExtendedAttributeNames() - Method in class com.ibm.retail.saf.provider.POSInfoImpl
 
getExtendedPrice() - Method in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
getExtendedPrice() - Method in interface com.ibm.retail.saf.provider.ReceiptLineItem
Get the extended price of the item.
getFont() - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
 
getFont() - Method in interface com.ibm.retail.saf.provider.PrintLine
Returns a font value
getInstance() - Static method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
Get an instance of the factory.
getInstance() - Static method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
Get an instance of the factory.
getItemCode() - Method in interface com.ibm.retail.saf.provider.ItemIdentifier
Get the item code string.
getItemCode() - Method in class com.ibm.retail.saf.provider.ScannedItemIdentifier
Get the item code string.
getItemCodeType() - Method in interface com.ibm.retail.saf.provider.ItemIdentifier
Get the item code type.
getItemCodeType() - Method in class com.ibm.retail.saf.provider.ScannedItemIdentifier
Get the item code type.
getItemCount() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getItemCount() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the number of items.
getItemDescription() - Method in class com.ibm.retail.saf.provider.DefaultPriceInfo
Get the item description.
getItemDescription() - Method in interface com.ibm.retail.saf.provider.PriceInfo
Get the item description.
getItemIdentifier() - Method in class com.ibm.retail.saf.provider.DefaultLineItem
 
getItemIdentifier() - Method in class com.ibm.retail.saf.provider.DefaultPriceInfo
Get the item identifier.
getItemIdentifier() - Method in interface com.ibm.retail.saf.provider.LineItem
Get the item identifier for this line item.
getItemIdentifier() - Method in interface com.ibm.retail.saf.provider.PriceInfo
Get the item identifier.
getItemList() - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
 
getItemList() - Method in interface com.ibm.retail.saf.provider.PriceRequest
Gets the list of ItemIdentifiers contained in the request.
getLegalText() - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
getLegalText() - Method in interface com.ibm.retail.saf.provider.PaymentResult
Gets an iterator for the Legal text associated with tender
getLineFeedCount() - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
 
getLineFeedCount() - Method in interface com.ibm.retail.saf.provider.PrintLine
Returns a count of the number of line feeds to insert after line
getLineItemList() - Method in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
getLineItemList() - Method in interface com.ibm.retail.saf.provider.TransactionRequest
Gets the list of LineItems contained in the request.
getMaskedAccountNumber() - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
getMaskedAccountNumber() - Method in interface com.ibm.retail.saf.provider.PaymentResult
Gets the masked payment card account number in this PaymentResult.
getMessage() - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
getMessage() - Method in interface com.ibm.retail.saf.provider.LogRequest
Get the message text for this exception.
getNumberOfPrices() - Method in class com.ibm.retail.saf.provider.DefaultPriceResult
 
getNumberOfPrices() - Method in interface com.ibm.retail.saf.provider.PriceResult
Gets the total number of items in this PriceResult.
getNumberOfPrintLines() - Method in interface com.ibm.retail.saf.provider.CashReceiptImage
Provides the number of print lines in the filtered (no attributes) receipt
getNumberOfPrintLines() - Method in class com.ibm.retail.saf.provider.Default4690CashReceipt
 
getPaymentInformation() - Method in class com.ibm.retail.saf.provider.DefaultPaymentRequest
 
getPaymentInformation() - Method in interface com.ibm.retail.saf.provider.PaymentRequest
Gets the payment information provided for tendering the transaction at the point-of-sale.
getPaymentResult() - Method in class com.ibm.retail.saf.provider.TenderException
Get the PaymentResult
getPaymentResults() - Method in interface com.ibm.retail.saf.provider.Transaction
Returns the results from a payment operation on this transaction.
getPaymentResults() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
getPaymentType() - Method in class com.ibm.retail.saf.provider.CreditCard
 
getPaymentType() - Method in interface com.ibm.retail.saf.provider.PaymentInfo
 
getPOSServer() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
Get the POSServer for this instance.
getPOSServerFactory(ProviderRequest) - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
 
getPOSStatus() - Method in interface com.ibm.retail.saf.provider.POSProvider
Get status of the virtual POS session This method provides a means for the client to interrogate the status of the virtual POS session state and whether point-of-sale exception log.
getPOSStatus() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
 
getPOSTransactionNumber() - Method in class com.ibm.retail.saf.provider.DefaultTransactionID
 
getPOSTransactionNumber() - Method in interface com.ibm.retail.saf.provider.TransactionID
Returns the transaction number assigned by the point-of-sale system.
getPrice(ItemIdentifier) - Method in class com.ibm.retail.saf.provider.DefaultPriceResult
 
getPrice(ItemIdentifier) - Method in interface com.ibm.retail.saf.provider.PriceResult
Gets the price of an item in this PriceResult.
getPriceType() - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
Gets the price type of this request.
getPriceType() - Method in interface com.ibm.retail.saf.provider.PriceRequest
Gets the price type of this request.
getPrintLines() - Method in interface com.ibm.retail.saf.provider.CashReceiptImage
Provides an iterator for the filtered print line objects on the cash receipt.
getPrintLines() - Method in class com.ibm.retail.saf.provider.Default4690CashReceipt
 
getQuantity() - Method in class com.ibm.retail.saf.provider.DefaultLineItem
 
getQuantity() - Method in interface com.ibm.retail.saf.provider.LineItem
Get the quantity purchased.
getRawText() - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
 
getRawText() - Method in interface com.ibm.retail.saf.provider.PrintLine
Returns a text string containing embedded print control characters used by POS
getReceiptLineItems() - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
getReceiptLineItems() - Method in interface com.ibm.retail.saf.provider.TransactionResult
Get an iterator for the ReceiptLineItems contained in the result.
getReferenceNumber() - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
getReferenceNumber() - Method in interface com.ibm.retail.saf.provider.PaymentResult
Gets the reference number associated with the payment tender in this PaymentResult.
getRegularPrice() - Method in class com.ibm.retail.saf.provider.DefaultPriceInfo
Get the item price.
getRegularPrice() - Method in interface com.ibm.retail.saf.provider.PriceInfo
Get the item price.
getRequestIdentifier() - Method in interface com.ibm.retail.saf.provider.POSRequest
Gets the optional request identifier.
getRequestIdentifier() - Method in class com.ibm.retail.saf.provider.POSRequestImpl
 
getRequestInProgress() - Method in class com.ibm.retail.saf.provider.POSStatus
Determine the request that is currently in progress.
getResponseCode() - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
getResponseCode() - Method in interface com.ibm.retail.saf.provider.PaymentResult
Gets the EFT response code
getSequenceNumber() - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
getSequenceNumber() - Method in interface com.ibm.retail.saf.provider.PaymentResult
Gets the EFT sequence number
getState() - Method in class com.ibm.retail.saf.provider.POSStatus
Get state of POS Session.
getStateDescription() - Method in class com.ibm.retail.saf.provider.POSStatus
 
getSubTotal() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getSubTotal() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the subtotal amount due.
getTax() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getTax() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the tax amount due.
getTerminalNumber() - Method in class com.ibm.retail.saf.provider.DefaultProviderRequest
 
getTerminalNumber() - Method in class com.ibm.retail.saf.provider.DefaultTransactionID
 
getTerminalNumber() - Method in interface com.ibm.retail.saf.provider.ProviderRequest
Get the point-of-sale terminal number.
getTerminalNumber() - Method in interface com.ibm.retail.saf.provider.TransactionID
Returns the terminal number assigned by the point-of-sale system.
getText() - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
 
getText() - Method in interface com.ibm.retail.saf.provider.PrintLine
Returns a filtered text string containing just printable text
getTimeoutValue() - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
getTotal() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getTotal() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the transaction total amount due.
getTotalCouponAmount() - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
getTotalCouponAmount() - Method in interface com.ibm.retail.saf.provider.TransactionTotals
Get the total value of all coupons (ignoring taxes).
getTrackData(int) - Method in class com.ibm.retail.saf.provider.CreditCard
 
getTrackData(int) - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Gets the credit card track data.
getTransactionID() - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
getTransactionID() - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
getTransactionID() - Method in interface com.ibm.retail.saf.provider.LogRequest
Get the transaction identifier for this log request.
getTransactionID() - Method in interface com.ibm.retail.saf.provider.Transaction
Get the transaction identifier.
getTransactionID() - Method in interface com.ibm.retail.saf.provider.TransactionResult
Get the TransactionID s contained in the result.
getTransactionID() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
getTransactionPrices(TransactionRequest) - Method in interface com.ibm.retail.saf.provider.PriceChecker
Sends a request to the point-of-sale system to obtain the extended prices and transaction totals for an order.
getTransactionPrices(TransactionRequest) - Method in interface com.ibm.retail.saf.provider.PriceProvider
Sends a request to the point-of-sale system to obtain the extended prices and transaction totals for an order.
getTransactionPrices(TransactionRequest) - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
 
getTransactionTotals() - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
getTransactionTotals() - Method in interface com.ibm.retail.saf.provider.Transaction
Get the transaction totals.
getTransactionTotals() - Method in interface com.ibm.retail.saf.provider.TransactionResult
Get the TransactionTotals s contained in the result.
getTransactionTotals() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
getUnitPrice() - Method in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
getUnitPrice() - Method in interface com.ibm.retail.saf.provider.ReceiptLineItem
Get the unit price of the item.

H

hasExceptions() - Method in interface com.ibm.retail.saf.provider.POSResult
Return true if non-fatal exceptions occurred during processing of the request.
hasExceptions() - Method in class com.ibm.retail.saf.provider.POSResultImpl
 

I

initialize() - Static method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
Get an instance of the factory.
instance - Static variable in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
instance - Static variable in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
 
isCancelAllowed() - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Returns true if the transaction is in a state that allows it to be cancelled.
isCancelAllowed() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
isCentered() - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
 
isCentered() - Method in interface com.ibm.retail.saf.provider.PrintLine
Returns a boolean that determines whether line should be centered
isConfirmAllowed() - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Returns true if the transaction is in a state that allows it to be confirmed.
isConfirmAllowed() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
isCut() - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
 
isCut() - Method in interface com.ibm.retail.saf.provider.PrintLine
Returns a boolean that determines whether a paper cut should be done after line
isPaymentAllowed() - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Returns true if the transaction is in a state that allows a payment operation to be performed.
isPaymentAllowed() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
isPOSActive() - Method in interface com.ibm.retail.saf.provider.POSProvider
Checks the point-of-sale system associated with this provider to determine if it is in a state which allows requests to be sent from a client.
isPOSActive() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
 
isSalesAllowed() - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Returns true if the transaction is in a state that allows sales operations to be performed.
isSalesAllowed() - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
itemCount - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
ItemIdentifier - interface com.ibm.retail.saf.provider.ItemIdentifier.
Provides information needed to identify an item at the point-of-sale register.
itemIdentifiers() - Method in class com.ibm.retail.saf.provider.DefaultPriceResult
 
itemIdentifiers() - Method in interface com.ibm.retail.saf.provider.PriceResult
Gets an iterator for the item identifiers defined for this PriceResult.

K

KioskPOSProvider - interface com.ibm.retail.saf.provider.kiosk.KioskPOSProvider.
Accepts requests from a client application to process transactions on a point-of-sale system.
KioskPOSProviderFactory - class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory.
Provides an implementation of the factory pattern for KioskPOSProvider objects.
KioskPOSProviderFactory() - Constructor for class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
 
KioskPOSProviderImpl - class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl.
Provides an implementation of the KioskPOSProvider interface.
KioskPOSProviderImpl(ProviderRequest) - Constructor for class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
Constructor.
KioskPOSProviderImplTest - class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest.
JUnit test case.
KioskPOSProviderImplTest(String) - Constructor for class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
Constructor for KioskPOSProviderImplTest.
KioskRequestFactory - class com.ibm.retail.saf.provider.kiosk.KioskRequestFactory.
Provides an implementation of the POSRequestFactory API to produce instances of objects needed to create requests for the POS.
KioskRequestFactory() - Constructor for class com.ibm.retail.saf.provider.kiosk.KioskRequestFactory
 
KioskSalesTransaction - class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction.
Provides an implementation of SalesTransaction for Kiosk applications.
KioskSalesTransaction(KioskPOSProviderImpl) - Constructor for class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
Constructor

L

legalText - Variable in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
lineFeedCount - Variable in class com.ibm.retail.saf.provider.Default4690PrintLine
 
LineItem - interface com.ibm.retail.saf.provider.LineItem.
Provides item identifier and quantity information for an item.
lineItems - Variable in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
LogRequest - interface com.ibm.retail.saf.provider.LogRequest.
Provides information needed to log an exception in the point-of-sale exception log.

M

makeCreditPaymentInfo() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeCreditPaymentInfo() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create an instance of CreditPaymentInfo
makeDefaultItemIdentifier(String) - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeDefaultItemIdentifier(String) - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create a default item identifier from a String.
makeDefaultLineItem(String, String) - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeDefaultLineItem(String, String) - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create a default instance of LineItem from a String item code and a quantity.
makeItemIdentifier() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeItemIdentifier() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create an item identifier.
makeLineItem() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeLineItem() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create an instance of a LineItem.
makeLogRequest() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeLogRequest() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create a new LogRequest object
makePaymentRequest() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makePaymentRequest() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create a new PaymentRequest object
makePOSProvider(ProviderRequest) - Method in interface com.ibm.retail.saf.provider.POSProviderFactory
Create an instance of a POSProvider.
makePOSProvider(ProviderRequest) - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
 
makePriceRequest() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makePriceRequest() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create a new PriceRequest object
makeProviderRequest() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeProviderRequest() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create a new ProviderRequest object
makeSalesTransaction() - Method in interface com.ibm.retail.saf.provider.SalesProvider
Sends a request to the point-of-sale system to create a new sales transaction.
makeSalesTransaction() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
 
makeTransactionRequest() - Method in class com.ibm.retail.saf.provider.DefaultPOSRequestFactory
 
makeTransactionRequest() - Method in interface com.ibm.retail.saf.provider.POSRequestFactory
Create a new TransactionRequest object
maskedAccountNumber - Variable in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
MASTERCARD - Static variable in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Mastercard credit card type identifier
mPOSProvider - Variable in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
mPosProviderFactory - Variable in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
mPOSServerFactory - Variable in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
mRequestFactory - Variable in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 

P

payBalance(PaymentRequest) - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Sends a request to the point-of-sale system to tender payment for the balance and complete the transaction.
payBalance(PaymentRequest) - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
PAYMENT_IN_PROGRESS - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
PaymentInfo - interface com.ibm.retail.saf.provider.PaymentInfo.
Base interface for payment classes.
PaymentRequest - interface com.ibm.retail.saf.provider.PaymentRequest.
Provides payment information needed to tender a point-of-sale transaction.
paymentResult - Variable in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
PaymentResult - interface com.ibm.retail.saf.provider.PaymentResult.
Contains the results obtained from performing a payment on the point-of-sale system.
paymentType - Variable in class com.ibm.retail.saf.provider.CreditCard
 
PENDING_CANCEL - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
PENDING_CONFIRM - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
performSales(TransactionRequest) - Method in interface com.ibm.retail.saf.provider.SalesTransaction
Sends a transaction request to the point-of-sale system to perform the sales operations on the transaction.
performSales(TransactionRequest) - Method in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
POSException - exception com.ibm.retail.saf.provider.POSException.
POSException is the superclass of exceptions generated by operations performed on the point-of-sale system.
POSException() - Constructor for class com.ibm.retail.saf.provider.POSException
 
POSException(String) - Constructor for class com.ibm.retail.saf.provider.POSException
 
POSException(String, Throwable) - Constructor for class com.ibm.retail.saf.provider.POSException
 
POSException(Throwable) - Constructor for class com.ibm.retail.saf.provider.POSException
 
POSInfo - interface com.ibm.retail.saf.provider.POSInfo.
Provides an extensible interface for exchanging information with the point-of-sale system using attributes.
POSInfoImpl - class com.ibm.retail.saf.provider.POSInfoImpl.
Provides a HashMap implementation of POSInfo.
POSInfoImpl() - Constructor for class com.ibm.retail.saf.provider.POSInfoImpl
Constructs a POSInfo object with no attributes
POSProvider - interface com.ibm.retail.saf.provider.POSProvider.
Provides the common superinterface to define specific modes of accessing the point-of-sale system.
POSProviderFactory - interface com.ibm.retail.saf.provider.POSProviderFactory.
Provides a factory API to obtain instances of POSProvider objects.
POSRequest - interface com.ibm.retail.saf.provider.POSRequest.
Provides the information needed to process a client request for a point-of-sale operation.
POSRequestFactory - interface com.ibm.retail.saf.provider.POSRequestFactory.
Provides a factory API to obtain instances of objects needed to create requests for the POS.
POSRequestImpl - class com.ibm.retail.saf.provider.POSRequestImpl.
Base implementation of the POSRequest interface.
POSRequestImpl() - Constructor for class com.ibm.retail.saf.provider.POSRequestImpl
 
POSResult - interface com.ibm.retail.saf.provider.POSResult.
Contains information returned from the point-of-sale system.
POSResultImpl - class com.ibm.retail.saf.provider.POSResultImpl.
Base implementation of the POSResult interface.
POSResultImpl() - Constructor for class com.ibm.retail.saf.provider.POSResultImpl
Constructs a POSResult with no attributes
POSStatus - class com.ibm.retail.saf.provider.POSStatus.
Contains the status of the POSProvider.
POSStatus(byte, String) - Constructor for class com.ibm.retail.saf.provider.POSStatus
Default Constructor
posTransactionNumber - Variable in class com.ibm.retail.saf.provider.DefaultTransactionID
 
PriceChecker - interface com.ibm.retail.saf.provider.PriceChecker.
Accepts requests to perform price inquiries on a point-of-sale system.
PriceInfo - interface com.ibm.retail.saf.provider.PriceInfo.
Contains price information about an item in the point-of-sale system.
PriceProvider - interface com.ibm.retail.saf.provider.PriceProvider.
Accepts requests to perform price inquiries on a point-of-sale system.
PriceRequest - interface com.ibm.retail.saf.provider.PriceRequest.
Provides information needed to determine prices for the list of items.
PriceResult - interface com.ibm.retail.saf.provider.PriceResult.
Contains the results obtained from performing a price lookup on the point-of-sale system.
prices - Variable in class com.ibm.retail.saf.provider.DefaultPriceResult
 
PrintLine - interface com.ibm.retail.saf.provider.PrintLine.
PrintLine provides access to the line that was sent to the point-of-sale printer by the POS application.
printLines - Variable in class com.ibm.retail.saf.provider.Default4690CashReceipt
 
providerCache - Variable in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
 
ProviderRequest - interface com.ibm.retail.saf.provider.ProviderRequest.
Provides the information needed to process a client request for an instance of a POSProvider.
ProviderStateException - exception com.ibm.retail.saf.provider.ProviderStateException.
A ProviderStateException is thrown when a request is made to perform a new request while the POSProvider is attempting error recovery or cleanup from a failed transaction.
ProviderStateException() - Constructor for class com.ibm.retail.saf.provider.ProviderStateException
 
ProviderStateException(String) - Constructor for class com.ibm.retail.saf.provider.ProviderStateException
 

R

rawText - Variable in class com.ibm.retail.saf.provider.Default4690PrintLine
 
ReceiptLineItem - interface com.ibm.retail.saf.provider.ReceiptLineItem.
Provides the information resulting from the sale of an item at the point-of-sale register.
receiptLineItems - Variable in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
RecoveryException - exception com.ibm.retail.saf.provider.RecoveryException.
A RecoveryException is thrown when a request is made to perform a new request while the POSProvider is attempting error recovery or cleanup from a failed transaction.
RecoveryException() - Constructor for class com.ibm.retail.saf.provider.RecoveryException
 
RecoveryException(String) - Constructor for class com.ibm.retail.saf.provider.RecoveryException
 
referenceNumber - Variable in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
REGULAR_PRICE - Static variable in interface com.ibm.retail.saf.provider.PriceRequest
Used to specify a price request for regular non-discounted) unit prices.
release() - Method in interface com.ibm.retail.saf.provider.POSProvider
Releases the point-of-sale resources associated with this POSProvider.
release() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImpl
 
removeAttribute(String) - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
removeException(Object) - Method in class com.ibm.retail.saf.provider.POSResultImpl
 
removeExtendedAttribute(String) - Method in interface com.ibm.retail.saf.provider.POSInfo
Removes an extended attribute and its value from the request.
removeExtendedAttribute(String) - Method in class com.ibm.retail.saf.provider.POSInfoImpl
 
removeItem(ItemIdentifier) - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
 
removeItem(ItemIdentifier) - Method in interface com.ibm.retail.saf.provider.PriceRequest
Removes an ItemIdentifier from the request.
removeLineItem(LineItem) - Method in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
removeLineItem(LineItem) - Method in interface com.ibm.retail.saf.provider.TransactionRequest
Removes a LineItem from the request.
removePrice(ItemIdentifier) - Method in class com.ibm.retail.saf.provider.DefaultPriceResult
 
removeReceiptLineItem(ReceiptLineItem) - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
RequestException - exception com.ibm.retail.saf.provider.RequestException.
A RequestException indicates that a POSRequest has invalid or missing attributes.
RequestException() - Constructor for class com.ibm.retail.saf.provider.RequestException
 
RequestException(String) - Constructor for class com.ibm.retail.saf.provider.RequestException
 
RequestException(String, Throwable) - Constructor for class com.ibm.retail.saf.provider.RequestException
 
RequestException(Throwable) - Constructor for class com.ibm.retail.saf.provider.RequestException
 
requestID - Variable in class com.ibm.retail.saf.provider.POSRequestImpl
 
responseCode - Variable in class com.ibm.retail.saf.provider.DefaultPaymentResult
 

S

SalesProvider - interface com.ibm.retail.saf.provider.SalesProvider.
Accepts requests from a client application to process transactions on a point-of-sale system.
SalesTransaction - interface com.ibm.retail.saf.provider.SalesTransaction.
Provides an interface to perform point-of-sale operations with an active POS transaction.
SCAN_LABEL - Static variable in interface com.ibm.retail.saf.provider.ItemIdentifier
Identifies the item code string as a scanned label, typically a UPC.
ScannedItemIdentifier - class com.ibm.retail.saf.provider.ScannedItemIdentifier.
Provides a default implementation of an item identifier.
ScannedItemIdentifier() - Constructor for class com.ibm.retail.saf.provider.ScannedItemIdentifier
Constructs an item identifier.
ScannedItemIdentifier(String) - Constructor for class com.ibm.retail.saf.provider.ScannedItemIdentifier
Constructs an item identifier with an item code string.
sequenceNumber - Variable in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
server - Variable in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
SERVER_BUSY - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
SERVER_INITIALIZING - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
SERVER_READY - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
serverFactory - Variable in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
 
serverTransaction - Variable in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
setAccountNumber(String) - Method in class com.ibm.retail.saf.provider.CreditCard
 
setAccountNumber(String) - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Sets the account number.
setAlternateLoyaltyID(String) - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
Sets the alternate loyalty or customer number for this price request.
setAlternateLoyaltyID(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
setAlternateLoyaltyID(String) - Method in interface com.ibm.retail.saf.provider.PriceRequest
Sets the alternate loyalty or customer number for this price request.
setAlternateLoyaltyID(String) - Method in interface com.ibm.retail.saf.provider.TransactionRequest
Sets the alternate loyalty or customer number for this transaction.
setApprovalCode(String) - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
Set the approval code
setAttribute(String, Object) - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
setBalanceDue(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the balance due
setCardType(String) - Method in class com.ibm.retail.saf.provider.CreditCard
 
setCardType(String) - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Sets the card type.
setCashReceiptImage(CashReceiptImage) - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
setCentered(boolean) - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
Set the centered attribute
setChangeDue(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the change due
setClientTransactionNumber(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionID
 
setCouponCount(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the coupon amount
setCustomerLoyaltyID(String) - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
Sets a customer's loyalty identifier for this price request.
setCustomerLoyaltyID(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionRequest
 
setCustomerLoyaltyID(String) - Method in interface com.ibm.retail.saf.provider.PriceRequest
Sets a customer's loyalty identifier for this price request.
setCustomerLoyaltyID(String) - Method in interface com.ibm.retail.saf.provider.TransactionRequest
Sets a customer's loyalty identifier for this transaction.
setCut(boolean) - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
Set true if this is a paper cut.
setDescription(String) - Method in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
setDescription(String) - Method in interface com.ibm.retail.saf.provider.ReceiptLineItem
Set the description of the item.
setExpirationDate(String) - Method in class com.ibm.retail.saf.provider.CreditCard
 
setExpirationDate(String) - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Sets the expiration date.
setExtendedAttribute(String, Object) - Method in interface com.ibm.retail.saf.provider.POSInfo
Adds an extended attribute and the Object value of the attribute to the request.
setExtendedAttribute(String, Object) - Method in class com.ibm.retail.saf.provider.POSInfoImpl
 
setExtendedPrice(String) - Method in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
setExtendedPrice(String) - Method in interface com.ibm.retail.saf.provider.ReceiptLineItem
Set the extended price of the item.
setFont(int) - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
Set the font atribute.
setItemCode(String) - Method in interface com.ibm.retail.saf.provider.ItemIdentifier
Set the item code string.
setItemCode(String) - Method in class com.ibm.retail.saf.provider.ScannedItemIdentifier
Set the item code string.
setItemCodeType(byte) - Method in interface com.ibm.retail.saf.provider.ItemIdentifier
Set the item code type.
setItemCodeType(byte) - Method in class com.ibm.retail.saf.provider.ScannedItemIdentifier
Set the item code type.
setItemCount(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the item count
setItemDescription(String) - Method in class com.ibm.retail.saf.provider.DefaultPriceInfo
Set the item description.
setItemDescription(String) - Method in interface com.ibm.retail.saf.provider.PriceInfo
Set the item description.
setItemIdentifier(ItemIdentifier) - Method in class com.ibm.retail.saf.provider.DefaultLineItem
 
setItemIdentifier(ItemIdentifier) - Method in class com.ibm.retail.saf.provider.DefaultPriceInfo
Set the item identifier.
setItemIdentifier(ItemIdentifier) - Method in interface com.ibm.retail.saf.provider.LineItem
Set the item identifier for this line item.
setItemIdentifier(ItemIdentifier) - Method in interface com.ibm.retail.saf.provider.PriceInfo
Set the item identifier.
setLineFeedCount(int) - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
Set the line feed count
setMaskedAccountNumber(String) - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
Set the Masked Account Number
setMessage(String) - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
setMessage(String) - Method in interface com.ibm.retail.saf.provider.LogRequest
Set the message text for this exception.
setPaymentInformation(PaymentInfo) - Method in class com.ibm.retail.saf.provider.DefaultPaymentRequest
 
setPaymentInformation(PaymentInfo) - Method in interface com.ibm.retail.saf.provider.PaymentRequest
Sets the payment information provided for tendering the transaction at the point-of-sale.
setPaymentResult(PaymentResult) - Method in class com.ibm.retail.saf.provider.TenderException
Get the PaymentResult
setPOSServerFactory(POSServerFactory) - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderFactory
Method called to set up a non-standard POS Server Factory e.g. for test purposes
setPOSTerminalNumber(String) - Method in class com.ibm.retail.saf.provider.DefaultProviderRequest
 
setPOSTerminalNumber(String) - Method in interface com.ibm.retail.saf.provider.ProviderRequest
Set the point-of-sale terminal number.
setPosTransactionNumber(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionID
 
setPriceType(byte) - Method in class com.ibm.retail.saf.provider.DefaultPriceRequest
Sets the price type of this request.
setPriceType(byte) - Method in interface com.ibm.retail.saf.provider.PriceRequest
Sets the price type of this request.
setQuantity(String) - Method in class com.ibm.retail.saf.provider.DefaultLineItem
 
setQuantity(String) - Method in interface com.ibm.retail.saf.provider.LineItem
Set the quantity purchased.
setRawText(String) - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
Set the raw text.
setReferenceNumber(String) - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
Set the reference number
setRegularPrice(String) - Method in class com.ibm.retail.saf.provider.DefaultPriceInfo
Set the item price.
setRegularPrice(String) - Method in interface com.ibm.retail.saf.provider.PriceInfo
Set the item price.
setRequestIdentifier(String) - Method in class com.ibm.retail.saf.provider.POSRequestImpl
 
setResponseCode(String) - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
Set the response code
setSequenceNumber(String) - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
Set the sequence number
setSubTotal(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the sub total
setTax(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the tax
setTerminalNumber(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionID
 
setText(String) - Method in class com.ibm.retail.saf.provider.Default4690PrintLine
Set the plain text.
setTimeoutValue(int) - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
setTotal(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the total
setTotalCouponAmount(String) - Method in class com.ibm.retail.saf.provider.DefaultTransactionTotals
Set the total coupon amount
setTrackData(int, byte[]) - Method in class com.ibm.retail.saf.provider.CreditCard
 
setTrackData(int, byte[]) - Method in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Sets the credit card track data.
setTransactionID(TransactionID) - Method in class com.ibm.retail.saf.provider.DefaultLogRequest
 
setTransactionID(TransactionID) - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
setTransactionID(TransactionID) - Method in interface com.ibm.retail.saf.provider.LogRequest
Set the transaction identifier for this exception A Transaction ID provides a means of associating a transaction with the log record.
setTransactionTotals(TransactionTotals) - Method in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
setUnitPrice(String) - Method in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
setUnitPrice(String) - Method in interface com.ibm.retail.saf.provider.ReceiptLineItem
Set the unit price of the item.
setUp() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
SKU - Static variable in interface com.ibm.retail.saf.provider.ItemIdentifier
Identifies the item code string as an SKU.
StateConstants - interface com.ibm.retail.saf.provider.StateConstants.
Defines constants for POS transaction states.
StateDescriptors - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
subTotal - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 

T

tax - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
tearDown() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
TenderException - exception com.ibm.retail.saf.provider.TenderException.
A TenderException is generated when the request to tender payment fails to complete successfully on the point-of-sale system.
TenderException() - Constructor for class com.ibm.retail.saf.provider.TenderException
 
TenderException(String) - Constructor for class com.ibm.retail.saf.provider.TenderException
 
TenderException(String, Throwable) - Constructor for class com.ibm.retail.saf.provider.TenderException
 
TenderException(Throwable) - Constructor for class com.ibm.retail.saf.provider.TenderException
 
terminalNumber - Variable in class com.ibm.retail.saf.provider.DefaultProviderRequest
 
terminalNumber - Variable in class com.ibm.retail.saf.provider.DefaultTransactionID
 
testGetPOSStatus() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
testGetTransactionPrices() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
testIsPOSActiveReturnsFalseWhileInitializing() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
testMakeSalesTransaction() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
testPerformSalesTransactionBasic() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
testRelease() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
testSingleItemBasicUnitPriceCheck() - Method in class com.ibm.retail.saf.provider.kiosk.KioskPOSProviderImplTest
 
text - Variable in class com.ibm.retail.saf.provider.Default4690PrintLine
 
TimeoutException - exception com.ibm.retail.saf.provider.TimeoutException.
A TimeoutException is generated when the timeout value specified by the client expires before the requested point-of-sale operation has completed.
TimeoutException() - Constructor for class com.ibm.retail.saf.provider.TimeoutException
 
TimeoutException(String) - Constructor for class com.ibm.retail.saf.provider.TimeoutException
 
TimeoutException(String, Throwable) - Constructor for class com.ibm.retail.saf.provider.TimeoutException
 
TimeoutException(Throwable) - Constructor for class com.ibm.retail.saf.provider.TimeoutException
 
toString() - Method in class com.ibm.retail.saf.provider.DefaultPaymentResult
 
toString() - Method in class com.ibm.retail.saf.provider.DefaultPriceInfo
Returns a String representation of this item code.
toString() - Method in class com.ibm.retail.saf.provider.POSStatus
 
toString() - Method in interface com.ibm.retail.saf.provider.PaymentResult
Convert the PaymentResult details into a string
toString() - Method in class com.ibm.retail.saf.provider.ScannedItemIdentifier
Returns a String representation of this item code.
total - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
totalCouponAmount - Variable in class com.ibm.retail.saf.provider.DefaultTransactionTotals
 
Transaction - interface com.ibm.retail.saf.provider.Transaction.
Provides an interface to perform point-of-sale operations with an active POS transaction.
TRANSACTION_RESET - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
TRANSACTION_ROLLBACK - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
TRANSACTION_STARTED - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
TRANSACTION_STARTING - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
transactionID - Variable in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
TransactionID - interface com.ibm.retail.saf.provider.TransactionID.
Provides a unique identification of a transaction.
TransactionInProgressException - exception com.ibm.retail.saf.provider.TransactionInProgressException.
A TransactionInProgressException is thrown when a request is made to start a new transaction or perform a new request while a Transaction is active.
TransactionInProgressException() - Constructor for class com.ibm.retail.saf.provider.TransactionInProgressException
 
TransactionInProgressException(String) - Constructor for class com.ibm.retail.saf.provider.TransactionInProgressException
 
TransactionRequest - interface com.ibm.retail.saf.provider.TransactionRequest.
Provides the item and customer information to be added to a point-of-sale transaction.
transactionResult - Variable in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
TransactionResult - interface com.ibm.retail.saf.provider.TransactionResult.
Contains the results of processing a point-of-sale transaction.
transactionState - Variable in class com.ibm.retail.saf.provider.kiosk.KioskSalesTransaction
 
TransactionStateException - exception com.ibm.retail.saf.provider.TransactionStateException.
A TransactionStateException is thrown when a request is made to perform an action on a Transaction that is not in the proper state.
TransactionStateException() - Constructor for class com.ibm.retail.saf.provider.TransactionStateException
 
TransactionStateException(String) - Constructor for class com.ibm.retail.saf.provider.TransactionStateException
 
transactionTotals - Variable in class com.ibm.retail.saf.provider.DefaultTransactionResult
 
TransactionTotals - interface com.ibm.retail.saf.provider.TransactionTotals.
Provides the totals associated with performing a transaction at the point-of-sale register.

U

UNDEFINED - Static variable in interface com.ibm.retail.saf.provider.StateConstants
 
unitPrice - Variable in class com.ibm.retail.saf.provider.DefaultReceiptLineItem
 
UNKNOWN - Static variable in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Unknown credit card type identifier

V

VELOCITY - Static variable in interface com.ibm.retail.saf.provider.ItemIdentifier
Identifies the item code string as an VELOCITY code or PLU code.
VISA - Static variable in interface com.ibm.retail.saf.provider.CreditPaymentInfo
Visa credit card type identifier

A B C D E F G H I K L M P R S T U V