OSID Logo
OSID Specifications
authentication package
Version 3.1.0
Interfaceosid.authentication.AgencyList
Implementsosid.OsidList
Used Byosid.authentication.AgencyHierarchySession
osid.authentication.AgencyLookupSession
osid.authentication.AgencyQuerySession
osid.authentication.AgencySearchResults
osid.authentication.AgentAgencySession
osid.authentication.keys.KeyAgencySession
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.Agency the next Agency in this list. The hasNext() method should be used to test that a next Agency 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.
MethodgetNextAgencies
Description

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

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