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

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

                     
                     
                     while (rpl.hasNext()) {
                          ResponsePeer peer = rpl.getNextResponsePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rpl.hasNext()) {
                          ResponsePeer[] peers = rpl.getNextResponsePeers(rpl.available());
                     }
                     
                                 
                     
                
MethodgetNextResponsePeer
Description

Gets the next ResponsePeer in this list.

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

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

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