OSID Logo
OSID Specifications
repository batch package
Version 3.1.0
Interfaceosid.repository.batch.RepositoryBatchFormList
Implementsosid.OsidList
Used Byosid.repository.batch.RepositoryBatchAdminSession
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.RepositoryBatchForm the next RepositoryBatchForm in this list. The hasNext() method should be used to test that a next RepositoryBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.