OSID Logo
OSID Specifications
mapping path batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.batch.PathBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pbfl.hasNext()) {
                          PathBatchForm form = pbfl.getNextPathBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PathBatchForm[] forms = pbfl.getNextPathBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPathBatchForm
Description

Gets the next PathBatchForm in this list.

Returnosid.mapping.path.batch.PathBatchFormthe next PathBatchForm in this list. The hasNext() method should be used to test that a next PathBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextPathBatchForms
Description

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

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