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

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

                     
                     
                     while (fbfl.hasNext()) {
                          ForumBatchForm form = fbfl.getNextForumBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fbfl.hasNext()) {
                          ForumBatchForm[] forms = fbfl.getNextForumBatchForms(fbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextForumBatchForm
Description

Gets the next ForumBatchForm in this list.

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

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

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