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

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

                     
                     
                     while (cbfl.hasNext()) {
                          IntersectionBatchForm form = cbfl.getNextIntersectionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          IntersectionBatchForm[] forms = cbfl.getNextIntersectionBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextIntersectionBatchForm
Description

Gets the next IntersectionBatchForm in this list.

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

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

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