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

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

                     
                     
                     while (al.hasNext()) {
                          Appointment appointment = al.getNextAppointment();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Appointment[] appointments = al.getNextAppointments(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAppointment
Description

Gets the next Appointment in this list.

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

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

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