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

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

                     
                     
                     while (pbfl.hasNext()) {
                          PostBatchForm form = pbfl.getNextPostBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PostBatchForm[] forms = pbfl.getNextPostBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPostBatchForm
Description

Gets the next PostBatchForm in this list.

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

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

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