org.osid.authentication.keys

Interface KeyQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface KeyQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining key queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAgentIdTerms() Gets the agent Id terms.
AgentQueryInspector[]	getAgentTerms() Gets the agent terms.
KeyQueryInspectorRecord	getKeyQueryInspectorRecord(Type keyRecordType) Gets the key query inspector record corresponding to the given Key record Type.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getAgentIdTerms

IdTerm[] getAgentIdTerms()

Gets the agent Id terms.

Returns:

the agent Id terms

Compliance:

mandatory - This method must be implemented.

getAgentTerms

AgentQueryInspector[] getAgentTerms()

Gets the agent terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getKeyQueryInspectorRecord

KeyQueryInspectorRecord getKeyQueryInspectorRecord(Type keyRecordType)
                                                   throws OperationFailedException

Gets the key query inspector record corresponding to the given Key record Type.

Parameters:

keyRecordType - a key record type

Returns:

the key query inspector record

Throws:

NullArgumentException - keyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(keyRecordType) is false

Compliance:

mandatory - This method must be implemented.