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

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

                     
                     
                     while (qbfl.hasNext()) {
                          QualifierBatchForm form = qbfl.getNextQualifierBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (qbfl.hasNext()) {
                          QualifierBatchForm[] forms = qbfl.getNextQualifierBatchForms(qbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextQualifierBatchForm
Description

Gets the next QualifierBatchForm in this list.

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

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

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