OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.ResponseList
Implementsosid.OsidList
Used Byosid.inquiry.ResponseInquestSession
osid.inquiry.ResponseLookupSession
osid.inquiry.ResponseQuerySession
osid.inquiry.ResponseSearchResults
Description

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

while (rl.hasNext()) {
     Response response = rl.getNextResponse();
}
                
or
while (rl.hasNext()) {
     Response[] responses = rl.getNextResponses(rl.available());
}
                
MethodgetNextResponse
Description

Gets the next Response in this list.

Returnosid.inquiry.Response the next Response in this list. The hasNext() method should be used to test that a next Response is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextResponses
Description

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

Parameterscardinaln the number of Response elements requested which must be less than or equal to available()
Returnosid.inquiry.Response[] an array of Response elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.