| Interface | osid.authentication.AgencyList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Used By | osid.authentication.AgencyHierarchySession | ||
osid.authentication.AgencyLookupSession | |||
osid.authentication.AgencyQuerySession | |||
osid.authentication.AgencySearchResults | |||
osid.authentication.AgentAgencySession | |||
osid.authentication.keys.KeyAgencySession | |||
| Description |
Like all while (al.hasNext()) {
Agency agency = al.getNextAgency();
}
or
while (al.hasNext()) {
Agency[] agencies = al.getNextAgencies(al.available());
}
| ||
| Method | getNextAgency | ||
| Description |
Gets the next | ||
| Return | osid.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. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextAgencies | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of Agency elements requested which must be less
than or equal to available() |
| Return | osid.authentication.Agency[] | an array of Agency eleme nts. The length of the
array is less than or equal to the number specified. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |