OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.FunctionBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fbfl.hasNext()) {
                          FunctionBatchForm form = fbfl.getNextFunctionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fbfl.hasNext()) {
                          FunctionBatchForm[] forms = fbfl.getNextFunctionBatchForms(fbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextFunctionBatchForm
Description

Gets the next FunctionBatchForm in this list.

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

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

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