OSID Logo
OSID Specifications
resourcing batch package
Version 3.1.0
Interfaceosid.resourcing.batch.AvailabilityBatchFormList
Implementsosid.OsidList
Used Byosid.resourcing.batch.AvailabilityBatchAdminSession
Description

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

while (abfl.hasNext()) {
     AvailabilityBatchForm form = abfl.getNextAvailabilityBatchForm();
}
                
or
while (abfl.hasNext()) {
     AvailabilityBatchForm[] forms = abfl.getNextAvailabilityBatchForms(abfl.available());
}
                
MethodgetNextAvailabilityBatchForm
Description

Gets the next AvailabilityBatchForm in this list.

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

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

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