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

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

                     
                     
                     while (abfl.hasNext()) {
                          AgentBatchForm form = afl.getNextAgentBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AgentBatchForm[] forms = abfl.getNextAgentBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAgentBatchForm
Description

Gets the next AgentBatchForm in this list.

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

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

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