OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.InquiryEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (iel.hasNext()) {
                          InquiryEnabler enabler = iel.getNextInquiryEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (iel.hasNext()) {
                          InquiryEnabler[] enablers = iel.getNextInquiryEnablers(iel.available());
                     }
                     
                                 
                     
                
MethodgetNextInquiryEnabler
Description

Gets the next InquiryEnabler in this list.

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

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

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