OSID Logo
OSID Specifications
commenting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.batch.CommentBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cbfl.hasNext()) {
                          CommentBatchForm form = cbfl.getNextCommentBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CommentBatchForm[] forms = cbfl.getNextCommentBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCommentBatchForm
Description

Gets the next CommentBatchForm in this list.

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

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

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