OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.ParticipantPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (popl.hasNext()) {
                          ParticipantPeer peer = popl.getNextParticipantPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (popl.hasNext()) {
                          ParticipantPeer[] peers = popl.getNextParticipantPeers(popl.available());
                     }
                     
                                 
                     
                
MethodgetNextParticipantPeer
Description

Gets the next ParticipantPeer in this list.

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

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

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