OSID Logo
OSID Specifications
calendaring batch package
Version 3.1.0
Interfaceosid.calendaring.batch.TimePeriodBatchFormList
Implementsosid.OsidList
Used Byosid.calendaring.batch.TimePeriodBatchAdminSession
Description

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

while (tpbfl.hasNext()) {
     TimePeriodBatchForm form = tpbfl.getNextTimePeriodBatchForm();
}
                
or
while (tpbfl.hasNext()) {
     TimePeriodBatchForm[] forms = tpbfl.getNextTimePeriodBatchForms(tpbfl.available());
}
                
MethodgetNextTimePeriodBatchForm
Description

Gets the next TimePeriodBatchForm in this list.

Returnosid.calendaring.batch.TimePeriodBatchForm the next TimePeriodBatchForm in this list. The hasNext() method should be used to test that a next TimePeriodBatchForm 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.
MethodgetNextTimePeriodBatchForms
Description

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

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