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

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

                     
                     
                     while (al.hasNext()) {
                          Agency agency = al.getNextAgency();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Agency[] agencies = al.getNextAgencies(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAgency
Description

Gets the next Agency in this list.

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

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

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