com.ibm.etill.framework.cassette
Class CancelOrderRequest
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.CancelOrderRequest
- All Implemented Interfaces:
- FrameworkReturnCodes, PaymentAPIConstants, Serializable
- public class CancelOrderRequest
- extends OrderRequest
CancelOrderRequest objects hold all the information necessary for a
cassette to process a given CANCELORDER API command.
Since the CANCELORDER API command operates on an Order,
CancelOrderRequest extends OrderRequest.
- See Also:
APIResponse
, Serialized Form
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. |
CancelOrderRequest
public CancelOrderRequest(ETillConnection connection,
Order order,
boolean deleteOrder,
ParameterTable frameworkKeywords,
ParameterTable protocolData)
throws ETillAbortOperation
- Constructs a CancelOrderRequest object which references or contains all of
the specified input parameters.
The Framework invokes this constructor every time a new CANCELORDER command
is received from a merchant application.
- Parameters:
connection
- the ETillConnection object over which the
CANCELORDER 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 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.
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.