OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.KeyQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching keys. Each method specifies an AND term while multiple invocations of the same method produce a nested OR, except for accessing the KeyQuery record.

MethodmatchAgentId
Description

Sets the agent Id for this query.

Parametersosid.id.IdagentIdan agent Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAgentIdTerms
Description

Clears the agent Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAgentQuery
Description

Tests if an AgentQuery is available.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentQuery
Description

Includes an agent query for making relations with Agents. Multiple retrievals return separate query terms nested inside this query term, each which are treated as a boolean OR.

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsAgentQuery() is false
CompliancemandatoryThis method must be implemented.
MethodclearAgentTerms
Description

Clears the agent terms.

CompliancemandatoryThis method must be implemented.
MethodgetKeyQueryRecord
Description

Gets the key query record corresponding to the given Key record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypekeyRecordTypea key record type
Returnosid.authentication.keys.records.KeyQueryRecordthe key query record
ErrorsNULL_ARGUMENT keyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(keyRecordType) is false
CompliancemandatoryThis method must be implemented.