OSID Logo
OSID Specifications
ontology batch package
Version 3.1.0
Interfaceosid.ontology.batch.OntologyBatchFormList
Implementsosid.OsidList
Used Byosid.ontology.batch.OntologyBatchAdminSession
Description

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

while (obfl.hasNext()) {
     OntologyBatchForm form = obfl.getNextOntologyBatchForm();
}
                
or
while (obfl.hasNext()) {
     OntologyBatchForm[] forms = obfl.getNextOntologyBatchForms(obfl.available());
}
                
MethodgetNextOntologyBatchForm
Description

Gets the next OntologyBatchForm in this list.

Returnosid.ontology.batch.OntologyBatchForm the next OntologyBatchForm in this list. The hasNext() method should be used to test that a next OntologyBatchForm 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.
MethodgetNextOntologyBatchForms
Description

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

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