OSID Logo
OSID Specifications
ontology package
Version 3.1.0
Interfaceosid.ontology.RelevancyList
Implementsosid.OsidList
Used Byosid.ontology.RelevancyLookupSession
osid.ontology.RelevancyOntologySession
osid.ontology.RelevancyQuerySession
osid.ontology.RelevancySearchResults
osid.ontology.rules.RelevancyEnablerRuleLookupSession
Description

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

while (rl.hasNext()) {
     Relevancy relevancy = rl.getNextRelevancy();
}
                
or
while (rl.hasNext()) {
     Relevancy[] relevancies = rl.getNextRelevancies(rl.available());
}
                
MethodgetNextRelevancy
Description

Gets the next Relevancy in this list.

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

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

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