OSID Logo
OSID Specifications
authentication batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.batch.AgencyBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (abfl.hasNext()) {
                          AgencyBatchForm form = abfl.getNextAgencyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AgencyBatchForm[] forms = abfl.getNextAgencyBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAgencyBatchForm
Description

Gets the next AgencyBatchForm in this list.

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

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

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