OSID - osid.authentication.keys.KeyQuery Service Interface Definition

Interface	osid.authentication.keys.KeyQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.authentication.keys.KeyQuerySession`
	`osid.authentication.keys.KeySearchSession`
	`osid.authentication.keys.KeySmartAgencySession`
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.
Method	matchAgentId
Description	Sets the agent `Id` for this query.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentIdTerms
Description	Clears the agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
Description	Tests if an `AgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentQuery
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`.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsAgentQuery()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentTerms
Description	Clears the agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	getKeyQueryRecord
Description	Gets the key query record corresponding to the given `Key` record `Type`.Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`keyRecordType`	a key record type
Return	`osid.authentication.keys.records.KeyQueryRecord`		the key query record
Errors	NULL_ARGUMENT		`keyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(keyRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.