OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancyList
Implementsosid.OsidList
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.Relevancythe next Relevancy in this list. The hasNext() method should be used to test that a next Relevancy is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe 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_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.