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

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

                     
                     
                     while (anl.hasNext()) {
                          AgencyNode node = anl.getNextAgencyNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (anl.hasNext()) {
                          AgencyNode[] nodes = anl.getNextAgencyNodes(anl.available());
                     }
                     
                                 
                     
                
MethodgetNextAgencyNode
Description

Gets the next AgencyNode in this list.

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

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

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