com.ibm.etill.framework.cassette
Class RefundRequest

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

public class RefundRequest
extends PaymentTransactionRequest

RefundRequest objects hold all the information necessary for a cassette to process a given REFUND API command. Since the REFUND API command operates on a Credit (specifically, it creates a new credit), RefundRequest extends PaymentTransactionRequest.

See Also:
APIResponse, Serialized Form

 
Constructor Summary
RefundRequest(ETillConnection connection, Credit credit, Amount amount, String batchNumber, ParameterTable frameworkKeywords, ParameterTable protocolData)
          Constructs a RefundtRequest 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

RefundRequest

public RefundRequest(ETillConnection connection,
                     Credit credit,
                     Amount amount,
                     String batchNumber,
                     ParameterTable frameworkKeywords,
                     ParameterTable protocolData)
              throws ETillAbortOperation
Constructs a RefundtRequest object which references or contains all of the specified input parameters. The Framework invokes this constructor every time a new REFUND command is received from a merchant application.
Parameters:
connection - the ETillConnection object over which the REFUND command was sent from the merchant application to Commerce Payments.
credit - the Credit object that the Framework created and initialized before calling this constructor.
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 refund 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.