OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.OublietteBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (obfl.hasNext()) {
                          OublietteBatchForm form = obfl.getNextOublietteBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (obfl.hasNext()) {
                          OublietteBatchForm[] forms = obfl.getNextOublietteBatchForms(obfl.available());
                     }
                     
                                 
                     
                
MethodgetNextOublietteBatchForm
Description

Gets the next OublietteBatchForm in this list.

Returnosid.hold.batch.OublietteBatchFormthe next OublietteBatchForm in this list. The hasNext() method should be used to test that a next OublietteBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextOublietteBatchForms
Description

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

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