OSID Logo
OSID Specifications
personnel batch package
Version 3.1.0
Interfaceosid.personnel.batch.AppointmentBatchFormList
Implementsosid.OsidList
Used Byosid.personnel.batch.AppointmentBatchAdminSession
Description

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

while (abfl.hasNext()) {
     AppointmentBatchForm form = abfl.getNextAppointmentBatchForm();
}
                
or
while (abfl.hasNext()) {
     AppointmentBatchForm[] forms = abfl.getNextAppointmentBatchForms(abfl.available());
}
                
MethodgetNextAppointmentBatchForm
Description

Gets the next AppointmentBatchForm in this list.

Returnosid.personnel.batch.AppointmentBatchForm the next AppointmentBatchForm in this list. The hasNext() method should be used to test that a next AppointmentBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextAppointmentBatchForms
Description

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

Parameterscardinaln the number of AppointmentBatchForm elements requested which must be less than or equal to available()
Returnosid.personnel.batch.AppointmentBatchForm[] an array of AppointmentBatchForm elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.