com.ibm.etill.framework.cassette
Interface CassetteOrder
- All Superinterfaces:
- Archivable
- public interface CassetteOrder
- extends Archivable
The CassetteOrder interface must be implemented by the class within
the cassette which represents the order to the cassette's payment protocol.
This object must be able to save itself to the database, therefor it extends the
Archivable interface.
Method Summary |
String |
accountNumber()
Returns the accountNumber with which this order is associated. |
short |
batchRequired()
Indicates to the Framework whether or not payments and credits associated with
this order should also be associated with a batch. |
Cassette |
cassette()
Returns the cassette's Cassette object. |
cassette
public Cassette cassette()
- Returns the cassette's Cassette object.
This is purely a convenience method. When the CassetteOrder is constructed, it
should store a reference to the Cassette object. That reference is then
returned by this method.
- Returns:
- Cassette - a reference to the Cassette object under which this
CassetteOrder is processed.
accountNumber
public String accountNumber()
- Returns the accountNumber with which this order is associated.
Before a payment can be associated with an order, the order must be associated
with an account. This method returns the account number once the association
has been established by the cassette.
- Returns:
- String - containing the accountNumber associated with this CassetteOrder
object.
batchRequired
public short batchRequired()
- Indicates to the Framework whether or not payments and credits associated with
this order should also be associated with a batch.
- Returns:
- short - if the value is 1 (true) then the Framework is instructed to
enforce the receipt of a BatchID on the API commands with a BatchID
parameter that specify this order. Any other returned value tells
the Framework to not enforce this rule.