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

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

                     
                     
                     while (inl.hasNext()) {
                          InquestNode node = inl.getNextInquestNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (inl.hasNext()) {
                          InquestNode[] nodes = inl.getNextInquestNodes(inl.available());
                     }
                     
                                 
                     
                
MethodgetNextInquestNode
Description

Gets the next InquestNode in this list.

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

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

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