com.ibm.etill.framework.cassette
Class AcceptPaymentRequest

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

public class AcceptPaymentRequest
extends OrderRequest

AcceptPaymentRequest objects hold all the information necessary for a cassette to process a given ACCEPTPAYEMNT API command. Since the ACCEPTPAYMENT API command operates on an Order (specifically, it creates a new order), AcceptPaymentRequest extends OrderRequest.

See Also:
APIResponse, Serialized Form

 
Constructor Summary
AcceptPaymentRequest(ETillConnection connection, Order order, ParameterTable frameworkKeywords, ParameterTable protocolData)
          Constructs an AcceptPaymentRequest object which references the specified connection, order, framework keywords, and protocol data parameters.
 
Method Summary
 boolean getApproveFlag()
          Indicates whether automatic approve was requested in the ACCEPTPAYMENT command string.
 boolean getDepositFlag()
          Indicates whether automatic deposit was requested in the ACCEPTPAYMENT command string.
 boolean getSplitsAllowed()
          Deprecated. If needed, SplitAllowed should be obtained from protocol data
 
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

AcceptPaymentRequest

public AcceptPaymentRequest(ETillConnection connection,
                            Order order,
                            ParameterTable frameworkKeywords,
                            ParameterTable protocolData)
                     throws ETillAbortOperation
Constructs an AcceptPaymentRequest object which references the specified connection, order, framework keywords, and protocol data parameters. The Framework invokes this constructor every time a new ACCEPTPAYMENT command is received from a merchant application.
Parameters:
connection - the ETillConnection object over which the ACCEPTPAYMENT command was sent from the merchant application to the Commerce Payments.
order - the Order object that the Framework created and initialized before calling this constructor.
frameworkKeywords - a ParameterTable containing all of the framework command parameters, keyed by their keywords.
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

getApproveFlag

public final boolean getApproveFlag()
Indicates whether automatic approve was requested in the ACCEPTPAYMENT command string.
Returns:
boolean - true if autoapprove was requested, false if not

getDepositFlag

public final boolean getDepositFlag()
Indicates whether automatic deposit was requested in the ACCEPTPAYMENT command string.
Returns:
boolean - true if autodeposit was requested, false if not

getSplitsAllowed

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

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