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

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

                     
                     
                     while (mnl.hasNext()) {
                          MailboxNode node = mnl.getNextMailboxNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mnl.hasNext()) {
                          MailboxNode[] nodes = mnl.getNextMailboxNodes(mnl.available());
                     }
                     
                                 
                     
                
MethodgetNextMailboxNode
Description

Gets the next MailboxNode in this list.

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

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

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