OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.KeySearch
Implementsosid.OsidSearch
Description

KeySearch defines options for governing key searches.

MethodsearchAmongKeys
Description

Execute this search among the given list of keys.

Parametersosid.id.IdListagentIdslist of agents
ErrorsNULL_ARGUMENT agentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderKeyResults
Description

Specify an ordering to the search results.

Parametersosid.authentication.keys.KeySearchOrderkeySearchOrderkey search order
ErrorsNULL_ARGUMENT keySearchOrder is null
UNSUPPORTED keySearchOrder is not of this service
CompliancemandatoryThis 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.TypekeySearchRecordTypea key search record type
Returnosid.authentication.keys.records.KeySearchRecordthe key search record
ErrorsNULL_ARGUMENT keySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(keySearchRecordType) is false
CompliancemandatoryThis method must be implemented.