OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.SchedulePeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (spl.hasNext()) {
                          SchedulePeer peer = spl.getNextSchedulePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (spl.hasNext()) {
                          SchedulePeer[] peers = spl.getNextSchedulePeers(spl.available());
                     }
                     
                                 
                     
                
MethodgetNextSchedulePeer
Description

Gets the next SchedulePeer in this list.

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

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

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