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

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

                     
                     
                     while (pl.hasNext()) {
                          Participant participant = pl.getNextParticipant();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Participant[] participants = pl.getNextParticipants(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextParticipant
Description

Gets the next Participant in this list.

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

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

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