OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.AvailabilityBatchFormList
Implementsosid.OsidList
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.AvailabilityBatchFormthe next AvailabilityBatchForm in this list. The hasNext() method should be used to test that a next AvailabilityBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe 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_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.