OSID Logo
OSID Specifications
personnel batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.batch.AppointmentPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (apl.hasNext()) {
                          AppointmentPeer peer = apl.getNextAppointmentPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (apl.hasNext()) {
                          AppointmentPeer[] peers = apl.getNextAppointmentPeers(apl.available());
                     }
                     
                                 
                     
                
MethodgetNextAppointmentPeer
Description

Gets the next AppointmentPeer in this list.

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

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

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