OSID Logo
OSID Specifications
subscription batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.batch.PublisherBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pbfl.hasNext()) {
                          PublisherBatchForm form = pbfl.getNextPublisherBtchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PublisherBatchForm[] forms = pbfl.getNextPublisherBatchFormspobfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPublisherBatchForm
Description

Gets the next PublisherBatchForm in this list.

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

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

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