com.ibm.etill.framework.cassette
Class ApproveReversalRequest

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

public class ApproveReversalRequest
extends PaymentTransactionRequest

ApproveReversalRequest objects hold all the information necessary for a cassette to process a given APPROVEREVERSAL API command. Since the APPROVEREVERSAL API command operates on a Payment, ApproveReversalRequest extends PaymentTransactionRequest.

See Also:
APIResponse, Serialized Form

 
Constructor Summary
ApproveReversalRequest(ETillConnection connection, Payment payment, Amount amount, boolean splitAllowed, ParameterTable frameworkKeywords, ParameterTable protocolData)
          Constructs an ApproveReversalRequest object which references or contains all of the specified input parameters.
 
Method Summary
 boolean getSplitsAllowed()
          Deprecated. If needed, SplitAllowed should be obtained from protocol data
 
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

ApproveReversalRequest

public ApproveReversalRequest(ETillConnection connection,
                              Payment payment,
                              Amount amount,
                              boolean splitAllowed,
                              ParameterTable frameworkKeywords,
                              ParameterTable protocolData)
                       throws ETillAbortOperation
Constructs an ApproveReversalRequest object which references or contains all of the specified input parameters. The Framework invokes this constructor every time a new APPROVEREVERSAL command is received from a merchant application.
Parameters:
connection - the ETillConnection object over which the APPROVEREVERSAL 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
splitAllowed - a boolean value that reflects the effective setting of the SPLITALLOWED parameter from the command string. true indicates that split payments are allowed and false indicates that they are not allowed.
frameworkKeywords - a ParameterTable that contains the framework 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.
Method Detail

getSplitsAllowed

public final boolean getSplitsAllowed()
Deprecated. If needed, SplitAllowed should be obtained from protocol data

Returns the SPLITALLOWED setting from the APPROVEREVERSAL command string.
Returns:
boolean - true if the command string indicated that split payments should be allowed, false if not