org.osid.authentication

Interface AgentQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface AgentQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining agent queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAgencyIdTerms() Gets the agency Id terms.
AgencyQueryInspector[]	getAgencyTerms() Gets the agency terms.
AgentQueryInspectorRecord	getAgentQueryInspectorRecord(Type agentRecordType) Gets the query inspector record corresponding to the given Agent record Type.
IdTerm[]	getResourceIdTerms() Gets the resource Id terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource terms.

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

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource terms.

Returns:

the resource terms

Compliance:

mandatory - This method must be implemented.

getAgencyIdTerms

IdTerm[] getAgencyIdTerms()

Gets the agency Id terms.

Returns:

the agency Id terms

Compliance:

mandatory - This method must be implemented.

getAgencyTerms

AgencyQueryInspector[] getAgencyTerms()

Gets the agency terms.

Returns:

the agency terms

Compliance:

mandatory - This method must be implemented.

getAgentQueryInspectorRecord

AgentQueryInspectorRecord getAgentQueryInspectorRecord(Type agentRecordType)
                                                       throws OperationFailedException

Gets the query inspector record corresponding to the given Agent record Type.

Parameters:

agentRecordType - an agent record type

Returns:

the agent query inspector record

Throws:

NullArgumentException - agentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agentRecordType) is false

Compliance:

mandatory - This method must be implemented.