OSID Logo
OSID Specifications
forum batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.batch.ReplyBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rbfl.hasNext()) {
                          ReplyBatchForm form = rbfl.getNextReplyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          ReplyBatchForm[] forms = rbfl.getNextReplyBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextReplyBatchForm
Description

Gets the next ReplyBatchForm in this list.

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

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

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