com.ibm.etill.kitcashcassette
Interface KitCashFSMConstants

All Known Implementing Classes:
KitCashFSM, KitCashPurchase

public interface KitCashFSMConstants


Field Summary
static java.lang.String[] actionStrings
          ACTION DEBUG STRINGS
static int BatchClosed
          BatchClosed is sent to the finite state machine when the account and the batch have been closed (and the payment has been sent to the KitCash bank).
static int CloseOrder
          Closes a settled order.
static int ContinuePayment
          Receives a KitCash protocol message from the wallet and returns a response KitCash protocol message.
static int Deposit
          The Deposit input is sent to the finite state machine when the KitCash protocol flow has concluded successfully.
static int EndOfConsumerFlow
          EndOfConsumerFlow is the input sent to the finite state machine when the merchant's KitCash card drvier signifies that the KitCash protocol flow has ended.
static int Error
          Error is the input sent to the finite state machine when the merchant's KitCash card driver signifies that the KitCash protocol flow ended in error.
static int ErrorState
          ErrorState is the state where an error has occurred during the processing of the purchase.
static int INVALID_INPUT
           
static int KitCashMsg
          KitCashMsg is the input sent to the finite state machine when a protocol message arrives from the KitCash wallet.
static int MarkPaymentAsComplete
          Records on the database that the payment associated with this purchase has been successfully transferred\ to the bank.
static int MarkPaymentAsReceived
          Records on the database that the KitCash protocol flow has completed successfully and that the consumer's money has been transffered to the merchant's KitCash card.
static int MarkPaymentForDeposit
          Records on the database that the purchase object has been added to a batch of payments to be transferred to the bank.
static int NO_STATE_CHANGE
          No State Change
static int OrderClosed
          Close order is sent to the finite state machine when the batch has been settled (closed) to delete the order from the database.
static int PaymentAddedToBatch
          PaymentAddedToBatch is the state where the payment has been added to a batch of payments ready to be transferred to the bank.
static int PaymentComplete
          PaymentComplete is the state where the payment associated with this purchase has been successfully transferred to the bank.
static int PaymentPending
          PaymentPending is the state where the consumer has authorized a payment, but the KitCash payment protocol flow has not yet concluded.
static int PaymentReceived
          PaymentReceived is the state where the payment flow has concluded successfully and the consumer's money has transferred from the consumer's KitCash card to the merchant's KitCash card.
static int PaymentRequested
          PaymentRequested is the state where an purchase request has been made by a consumer, but the consumer has not yet authorized the payment.
static int ReceivePayment
          ReceivePayment is the input sent to the finite state machine when the Merchant sends a RECEIVEPAYMENT API request to the Payment Server.
static int ReportError
          Reports that an error has occurred during processing.
static int SendInitiationMsg
          Sends the KitCash wallet applet tag back to the merchant.
static int Start
          The initial state for the finite state machine
static int StartPayment
          Receives a KitCash protocol message from the consumer and returns a response KitCash protocol message.
static java.lang.String[] stateStrings
          STATE DEBUG STRINGS
static int UNREACHABLE_STATE_ACTION
          The input and state have evaluated in a way that should never happen.
 

Field Detail

Start

public static final int Start
The initial state for the finite state machine

PaymentRequested

public static final int PaymentRequested
PaymentRequested is the state where an purchase request has been made by a consumer, but the consumer has not yet authorized the payment.

PaymentPending

public static final int PaymentPending
PaymentPending is the state where the consumer has authorized a payment, but the KitCash payment protocol flow has not yet concluded.

PaymentReceived

public static final int PaymentReceived
PaymentReceived is the state where the payment flow has concluded successfully and the consumer's money has transferred from the consumer's KitCash card to the merchant's KitCash card.

PaymentAddedToBatch

public static final int PaymentAddedToBatch
PaymentAddedToBatch is the state where the payment has been added to a batch of payments ready to be transferred to the bank.

PaymentComplete

public static final int PaymentComplete
PaymentComplete is the state where the payment associated with this purchase has been successfully transferred to the bank.

ErrorState

public static final int ErrorState
ErrorState is the state where an error has occurred during the processing of the purchase.

NO_STATE_CHANGE

public static final int NO_STATE_CHANGE
No State Change

stateStrings

public static final java.lang.String[] stateStrings
STATE DEBUG STRINGS

ReceivePayment

public static final int ReceivePayment
ReceivePayment is the input sent to the finite state machine when the Merchant sends a RECEIVEPAYMENT API request to the Payment Server.

KitCashMsg

public static final int KitCashMsg
KitCashMsg is the input sent to the finite state machine when a protocol message arrives from the KitCash wallet.

EndOfConsumerFlow

public static final int EndOfConsumerFlow
EndOfConsumerFlow is the input sent to the finite state machine when the merchant's KitCash card drvier signifies that the KitCash protocol flow has ended.

Error

public static final int Error
Error is the input sent to the finite state machine when the merchant's KitCash card driver signifies that the KitCash protocol flow ended in error.

Deposit

public static final int Deposit
The Deposit input is sent to the finite state machine when the KitCash protocol flow has concluded successfully.

BatchClosed

public static final int BatchClosed
BatchClosed is sent to the finite state machine when the account and the batch have been closed (and the payment has been sent to the KitCash bank).

OrderClosed

public static final int OrderClosed
Close order is sent to the finite state machine when the batch has been settled (closed) to delete the order from the database.

INVALID_INPUT

public static final int INVALID_INPUT

SendInitiationMsg

public static final int SendInitiationMsg
Sends the KitCash wallet applet tag back to the merchant.

StartPayment

public static final int StartPayment
Receives a KitCash protocol message from the consumer and returns a response KitCash protocol message. Records on the database that the order and payment are pending.

ContinuePayment

public static final int ContinuePayment
Receives a KitCash protocol message from the wallet and returns a response KitCash protocol message. Queries the merchant's KitCash card driver to determine whether the payment has concluded or not. Records the current state on the database.

MarkPaymentForDeposit

public static final int MarkPaymentForDeposit
Records on the database that the purchase object has been added to a batch of payments to be transferred to the bank.

MarkPaymentAsComplete

public static final int MarkPaymentAsComplete
Records on the database that the payment associated with this purchase has been successfully transferred\ to the bank.

MarkPaymentAsReceived

public static final int MarkPaymentAsReceived
Records on the database that the KitCash protocol flow has completed successfully and that the consumer's money has been transffered to the merchant's KitCash card.

ReportError

public static final int ReportError
Reports that an error has occurred during processing.

CloseOrder

public static final int CloseOrder
Closes a settled order.

UNREACHABLE_STATE_ACTION

public static final int UNREACHABLE_STATE_ACTION
The input and state have evaluated in a way that should never happen.

actionStrings

public static final java.lang.String[] actionStrings
ACTION DEBUG STRINGS