OSID Logo
OSID Specifications
ontology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.batch.RelevancyBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rbfl.hasNext()) {
                          RelevancyBatchForm form = rbfl.getNextRelevancyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RelevancyBatchForm[] forms = rbfl.getNextRelevancyBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRelevancyBatchForm
Description

Gets the next RelevancyBatchForm in this list.

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

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

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