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

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

                     
                     
                     while (il.hasNext()) {
                          Inquiry inquiry = il.getNextInquiry();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Inquiry[] inquiries = il.getNextInquiries(il.available());
                     }
                     
                                 
                     
                
MethodgetNextInquiry
Description

Gets the next Inquiry in this list.

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

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

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