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

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

                     
                     
                     while (mbfl.hasNext()) {
                          MailboxBatchForm form = mbfl.getNextMailboxBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mbfl.hasNext()) {
                          MailboxBatchForm[] forms = mbfl.getNextMailboxBatchForms(mbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextMailboxBatchForm
Description

Gets the next MailboxBatchForm in this list.

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

Gets the next set of MailboxBatchForm elements in this list. The specified amount must be less than or equal to the return from available().

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