| Interface | osid.authentication.keys.KeyList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Used By | osid.authentication.keys.KeyAgencySession | ||
osid.authentication.keys.KeyLookupSession | |||
osid.authentication.keys.KeyQuerySession | |||
osid.authentication.keys.KeySearchResults | |||
| Description |
Like all while (kl.hasNext()) {
Key key = kl.getNextKey();
}
or
while (kl.hasNext()) {
Key[] keys = kl.getNextKeys(kl.available());
}
| ||
| Method | getNextKey | ||
| Description |
Gets the next | ||
| Return | osid.authentication.keys.Key | the next Key in this list. The hasNext() method
should be used to test that a next Key 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 | getNextKeys | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of Key elements requested which should be less
than or equal to available() |
| Return | osid.authentication.keys.Key[] | an array of Key elements. 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. | |