OSID Logo
OSID Specifications
authentication keys package
Version 3.1.0
Interfaceosid.authentication.keys.KeyList
Implementsosid.OsidList
Used Byosid.authentication.keys.KeyAgencySession
osid.authentication.keys.KeyLookupSession
osid.authentication.keys.KeyQuerySession
osid.authentication.keys.KeySearchResults
Description

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

while (kl.hasNext()) {
     Key key = kl.getNextKey();
}
                
or
while (kl.hasNext()) {
     Key[] keys = kl.getNextKeys(kl.available());
}
                
MethodgetNextKey
Description

Gets the next Key in this list.

Returnosid.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.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextKeys
Description

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

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