com.ibm.etill.framework.cassette
Class DepositReversalRequest

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.DepositReversalRequest
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, Serializable

public class DepositReversalRequest
extends PaymentTransactionRequest

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

See Also:
APIResponse, Serialized Form

 
Constructor Summary
DepositReversalRequest(ETillConnection connection, Payment payment, ParameterTable frameworkKeywords, ParameterTable protocolData)
          Constructs a DepositReversalRequest 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

DepositReversalRequest

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

Note that deposit reversals must be issued within the same batch as the deposit that is being reversed. Therefore, no batchNumber parameter exists for this constructor or object.

Also note that only complete deposit reversals are supported by the Commerce Payments Framework. Therefore, no Amount parameter exists for this constructor or object.

Parameters:
connection - the ETillConnection object over which the DEPOSITREVERSAL command was sent from the merchant application to Commerce Payments.
payment - the Payment object at which this request is directed
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.