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

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

                     
                     
                     while (rel.hasNext()) {
                          RelevancyEnabler enabler = rel.getNextRelevancyEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rel.hasNext()) {
                          RelevancyEnabler[] enablers = rel.getNextRelevancyEnablers(rel.available());
                     }
                     
                                 
                     
                
MethodgetNextRelevancyEnabler
Description

Gets the next RelevancyEnabler in this list.

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

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

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