OSID Logo
OSID Specifications
messaging batch package
Version 3.1.0
Interfaceosid.messaging.batch.MessageBatchFormList
Implementsosid.OsidList
Used Byosid.messaging.batch.MessageBatchAdminSession
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.MessageBatchForm the next MessageBatchForm in this list. The hasNext() method should be used to test that a next MessageBatchForm 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.
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().

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