OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.ReceiptList
Implementsosid.OsidList
Description

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

Gets the next Receipt in this list.

Returnosid.messaging.Receiptthe next Receipt in this list. The hasNext() method should be used to test that a next Receipt is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextReceipts
Description

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

Parameterscardinalnthe number of Receipt elements requested which must be less than or equal to available()
Returnosid.messaging.Receipt[]an array of Receipt elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.