org.osid.messaging

Interface ReceiptList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

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().

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextReceipt

Receipt getNextReceipt()
                       throws OperationFailedException

Gets the next Receipt in this list.

Returns:

the next Receipt in this list. The hasNext() method should be used to test that a next Receipt is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextReceipts

Receipt[] getNextReceipts(long n)
                          throws OperationFailedException

Gets the next set of Receipts in this list which must be less than or equal to the return from available().

Parameters:

n - the number of Receipt elements requested which must be less than or equal to available()

Returns:

an array of Receipt elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.