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

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

                     
                     
                     while (al.hasNext()) {
                          Agent agent = al.getNextAgent();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Agent[] agents = al.getNextAgents(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAgent
Description

Gets the next Agent in this list.

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

Gets the next set of Agent elements in this list which must be less than or equal to the number returned from available().

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