OSID Logo
OSID Specifications
control batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.batch.InputPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ipl.hasNext()) {
                          InputPeer peer = ipl.getNextInputPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ipl.hasNext()) {
                          InputPeer[] peers = ipl.getNextInputPeers(ipl.available());
                     }
                     
                                 
                     
                
MethodgetNextInputPeer
Description

Gets the next InputPeer in this list.

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

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

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