com.ibm.etill.framework.cassette
Class BatchPurgeRequest

java.lang.Object
  |
  +--com.ibm.etill.framework.cassette.CassetteRequest
        |
        +--com.ibm.etill.framework.cassette.APIRequest
              |
              +--com.ibm.etill.framework.cassette.BatchRequest
                    |
                    +--com.ibm.etill.framework.cassette.BatchPurgeRequest
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, Serializable

public class BatchPurgeRequest
extends BatchRequest

BatchPurgeRequest objects hold all the information necessary for a cassette to process a given BATCHPURGE API command. Since the BATCHPURGE API command operates on a Batch, BatchPurgeRequest extends BatchRequest.

In addition to the locks obtained under the auspices of the ancestor BatchRequest class, the Framework also obtains the following lock on every Order object that owns a transaction in the batch to be purged:
ObjectLock TypeEffect
Order Write Prevents any other activity for the given order

See Also:
APIResponse, Serialized Form

 
Constructor Summary
BatchPurgeRequest(ETillConnection connection, Batch batch, ParameterTable frameworkKeywords, ParameterTable protocolData)
          Constructs a BatchPurgeRequest object which references or contains all of the specified input parameters.
 
Methods inherited from class com.ibm.etill.framework.cassette.BatchRequest
getAccountNumber, getBatch, getBatchNumber
 
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

BatchPurgeRequest

public BatchPurgeRequest(ETillConnection connection,
                         Batch batch,
                         ParameterTable frameworkKeywords,
                         ParameterTable protocolData)
                  throws ETillAbortOperation
Constructs a BatchPurgeRequest object which references or contains all of the specified input parameters. The Framework invokes this constructor every time a new BATCHPURGE command is received from a merchant application.
Parameters:
connection - the ETillConnection object over which the BATCHPURGE command was sent from the merchant application to the Commerce Payments.
batch - the Batch object at which this requset is directed.
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.