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

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

                     
                     
                     while (il.hasNext()) {
                          Inquest inquest = il.getNextInquest();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Inquest[] inquests = il.getNextInquests(il.available());
                     }
                     
                                 
                     
                
MethodgetNextInquest
Description

Gets the next Inquest in this list.

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

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

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