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

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

                     
                     
                     while (mbfl.hasNext()) {
                          MessageBatchForm form = mbfl.getNextMessageBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mbfl.hasNext()) {
                          MessageBatchForm[] forms = mbfl.getNextMessageBatchForms(mbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextMessageBatchForm
Description

Gets the next MessageBatchForm in this list.

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

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

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