OSID Logo
OSID Specifications
authentication package
Version 3.1.0
Interfaceosid.authentication.AgencyNodeList
Implementsosid.OsidList
Used Byosid.authentication.AgencyNode
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.AgencyNode the next AgencyNode in this list. The hasNext() method should be used to test that a next AgencyNode 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.
MethodgetNextAgencyNodes
Description

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

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