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

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

                     
                     
                     while (ol.hasNext()) {
                          Ontology ontology = ol.getNextOntology();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ol.hasNext()) {
                          Ontology[] ontologies = ol.getNextOntologies(ol.available());
                     }
                     
                                 
                     
                
MethodgetNextOntology
Description

Gets the next Ontology in this list.

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

Gets the next set of Ontology elements in this list which must be less than or equal to the return from available().

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