com.ibm.etill.framework.cassette
Class CloseOrderRequest

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

public class CloseOrderRequest
extends OrderRequest

CloseOrderRequest objects hold all the information necessary for a cassette to process a given CLOSEORDER API command. Since the CLOSEORDER API command operates on an Order, CloseOrderRequest extends OrderRequest.

See Also:
APIResponse, Serialized Form

 
Constructor Summary
CloseOrderRequest(ETillConnection connection, Order order, boolean deleteOrder, ParameterTable frameworkKeywords, ParameterTable protocolData)
          Constructs a CloseOrderRequest object which references or contains all of the specified input parameters.
 
Method Summary
 boolean getDeleteOrder()
          Indicates whether or not the Order object and all of its related objects (Payments, Credits, and cassette-specific objects) should be deleted from the database.
 
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

CloseOrderRequest

public CloseOrderRequest(ETillConnection connection,
                         Order order,
                         boolean deleteOrder,
                         ParameterTable frameworkKeywords,
                         ParameterTable protocolData)
                  throws ETillAbortOperation
Constructs a CloseOrderRequest object which references or contains all of the specified input parameters. The Framework invokes this constructor every time a new CLOSEORDER command is received from a merchant application.
Parameters:
connection - the ETillConnection object over which the CLOSEORDER command was sent from the merchant application to Commerce Payments.
order - the Order object at which this request is directed.
deleteOrder - a boolean value indicating whether or not the Order object and all of its related objects (Payments, Credits, and cassette-specific objects) should be deleted from the database. If this value is true then these objects will be deleted. Otherwise, they will not be deleted.
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.
Method Detail

getDeleteOrder

public boolean getDeleteOrder()
Indicates whether or not the Order object and all of its related objects (Payments, Credits, and cassette-specific objects) should be deleted from the database.
Returns:
boolean - true means the Order and related objects should be deleted. false means they should not be.