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

Like all OsidLists, MailboxList provides a means for accessing Mailbox elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (ml.hasNext()) {
                          Mailbox mailbox = ml.getNextMailbox();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ml.hasNext()) {
                          Mailbox[] mailboxes = ml.getNextMailboxes(ml.available());
                     }
                     
                                 
                     
                
MethodgetNextMailbox
Description

Gets the next Mailbox in this list.

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

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

Parameterscardinalnthe number of Mailbox elements requested which must be less than or equal to available()
Returnosid.messaging.Mailbox[]an array of Mailbox 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.