com.ibm.etill.framework.cassette
Class DepositRequest

java.lang.Object
  |
  +--com.ibm.etill.framework.cassette.CassetteRequest
        |
        +--com.ibm.etill.framework.cassette.APIRequest
              |
              +--com.ibm.etill.framework.cassette.OrderRequest
                    |
                    +--com.ibm.etill.framework.cassette.PaymentTransactionRequest
                          |
                          +--com.ibm.etill.framework.cassette.DepositRequest
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, Serializable

public class DepositRequest
extends PaymentTransactionRequest

DepositRequest objects hold all the information necessary for a cassette to process a given DEPOSIT API command. Since the DEPOSIT API command operates on a Payment (specifically, it creates a new payment), DepositRequest extends PaymentTransactionRequest.

See Also:
APIResponse, Serialized Form

 
Constructor Summary
DepositRequest(ETillConnection connection, Payment payment, Amount amount, String batchNumber, ParameterTable frameworkKeywords, ParameterTable protocolData)
          Constructs a DepositRequest object which references or contains all of the specified input parameters.
 
Methods inherited from class com.ibm.etill.framework.cassette.PaymentTransactionRequest
getAmount, getTransaction
 
Methods inherited from class com.ibm.etill.framework.cassette.OrderRequest
getAccount, getAccountNumber, getBatchNumber, getMerchant, getOrder
 
Methods inherited from class com.ibm.etill.framework.cassette.APIRequest
getFrameworkKeywords, getProtocolData
 
Methods inherited from class com.ibm.etill.framework.cassette.CassetteRequest
getConnection, getToken, obtainLocks, releaseLocks
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DepositRequest

public DepositRequest(ETillConnection connection,
                      Payment payment,
                      Amount amount,
                      String batchNumber,
                      ParameterTable frameworkKeywords,
                      ParameterTable protocolData)
               throws ETillAbortOperation
Constructs a DepositRequest object which references or contains all of the specified input parameters. The Framework invokes this constructor every time a new DEPOSIT command is received from a merchant application.

Cassettes may also need to construct DepositRequest objects in order to process the automatic deposit option of APPROVE.

Parameters:
connection - the ETillConnection object over which the DEPOSIT command was sent from the merchant application to Commerce Payments.
payment - the Payment object at which this request is directed
amount - the Amount object containing the amount, amountExp10 and currency values from the command string
batchNumber - a String that contains the batchNumber with which the deposit is to be associated.
frameworkKeywords - a ParameterTable that contains the generic command parameters that were specified on the command string.
protocolData - a ParameterTable that contains the protocol data parameters that were specified on the command string. If no such parameters were specified, then this value will be null.
Throws:
ETillAbortOperation - may be thrown by one of the ancestor classes' constructors.