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

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

                     
                     
                     while (abfl.hasNext()) {
                          AuthorizationBatchForm form = abfl.getNextAuthorizationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AuthorizationBatchForm[] forms = abfl.getNextAuthorizationBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAuthorizationBatchForm
Description

Gets the next AuthorizationBatchForm in this list.

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

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

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