OSID Logo
OSID Specifications
messaging package
Version 3.1.0
Interfaceosid.messaging.MailboxNodeList
Implementsosid.OsidList
Used Byosid.messaging.MailboxNode
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.MailboxNode the next MailboxNode in this list. The hasNext() method should be used to test that a next MailboxNode is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.