OSID Logo
OSID Specifications
authentication keys package
Version 3.1.0
Interfaceosid.authentication.keys.KeySearch
Implementsosid.OsidSearch
Used Byosid.authentication.keys.KeySearchSession
Description

KeySearch defines options for governing key searches.

MethodsearchAmongKeys
Description

Execute this search among the given list of keys.

Parametersosid.id.IdListagentIds list of agents
ErrorsNULL_ARGUMENT agentIds is null
Compliancemandatory This method must be implemented.
MethodorderKeyResults
Description

Specify an ordering to the search results.

Parametersosid.authentication.keys.KeySearchOrderkeySearchOrder key search order
ErrorsNULL_ARGUMENT keySearchOrder is null
UNSUPPORTED keySearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetKeySearchRecord
Description

Gets the record corresponding to the given key search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypekeySearchRecordType a key search record type
Returnosid.authentication.keys.records.KeySearchRecord the key search record
ErrorsNULL_ARGUMENT keySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(keySearchRecordType) is false
Compliancemandatory This method must be implemented.