OSID Logo
OSID Specifications
blogging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.batch.BlogBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bbfl.hasNext()) {
                          BlogBatchForm form = bbfl.getNextBlogBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BlogBatchForm[] forms = bbfl.getNextBlogBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBlogBatchForm
Description

Gets the next BlogBatchForm in this list.

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

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

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