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

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

                     
                     
                     while (abfl.hasNext()) {
                          AssetBatchForm form = abfl.getNextAssetBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AssetBatchForm[] forms = abfl.getNextAssetBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAssetBatchForm
Description

Gets the next AssetBatchForm in this list.

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

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

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