public interface ReceiptList extends OsidList
Like all OsidLists,
ReceiptList
provides
a means for accessing Message
elements sequentially either
one at a time or many at a time. Examples:
while (rl.hasNext()) { Receipt receipt = rl.getNextReceipt(); }or
while (rl.hasNext()) { Receipt[] receipts = rl.getNextReceipts(rl.available()); }
Modifier and Type | Method and Description |
---|---|
Receipt |
getNextReceipt()
Gets the next
Receipt in this list. |
Receipt[] |
getNextReceipts(long n)
Gets the next set of
Receipts in this list which must
be less than or equal to the return from available(). |
Receipt getNextReceipt() throws OperationFailedException
Receipt
in this list. Receipt
in this list. The
hasNext()
method should be used to test that a next
Receipt
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Receipt[] getNextReceipts(long n) throws OperationFailedException
Receipts
in this list which must
be less than or equal to the return from available().
n
- the number of Receipt
elements requested
which must be less than or equal to available()
Receipt
elements.
The length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.