OSID Logo
OSID Specifications
authentication batch package
Version 3.1.0
Interfaceosid.authentication.batch.AgencyBatchFormList
Implementsosid.OsidList
Used Byosid.authentication.batch.AgencyBatchAdminSession
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.AgencyBatchForm the next AgencyBatchForm in this list. The hasNext() method should be used to test that a next AgencyBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.