OSID Logo
OSID Specifications
repository batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.batch.RepositoryBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rbfl.hasNext()) {
                          RepositoryBatchForm form = rbfl.getNextRepositoryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RepositoryBatchForm[] forms = rbfl.getNextRepositoryBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRepositoryBatchForm
Description

Gets the next RepositoryBatchForm in this list.

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

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

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