org.osid.authentication

Interface AgencyQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface AgencyQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining queries.

Method Summary

Methods

Modifier and Type	Method and Description
AgencyQueryInspectorRecord	getAgencyQueryInspectorRecord(Type agencyRecordType) Gets the agency query inspector record corresponding to the given Agency record Type.
IdTerm[]	getAgentIdTerms() Gets the agent Id terms.
AgentQueryInspector[]	getAgentTerms() Gets the agent terms.
IdTerm[]	getAncestorAgencyIdTerms() Gets the ancestor agency Id terms.
AgencyQueryInspector[]	getAncestorAgencyTerms() Gets the ancestor agency terms.
IdTerm[]	getDescendantAgencyIdTerms() Gets the descendant agency Id terms.
AgencyQueryInspector[]	getDescendantAgencyTerms() Gets the descendant agency 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

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

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.

getAncestorAgencyIdTerms

IdTerm[] getAncestorAgencyIdTerms()

Gets the ancestor agency Id terms.

Returns:

the ancestor agency Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorAgencyTerms

AgencyQueryInspector[] getAncestorAgencyTerms()

Gets the ancestor agency terms.

Returns:

the ancestor agency terms

Compliance:

mandatory - This method must be implemented.

getDescendantAgencyIdTerms

IdTerm[] getDescendantAgencyIdTerms()

Gets the descendant agency Id terms.

Returns:

the descendant agency Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantAgencyTerms

AgencyQueryInspector[] getDescendantAgencyTerms()

Gets the descendant agency terms.

Returns:

the descendant agency terms

Compliance:

mandatory - This method must be implemented.

getAgencyQueryInspectorRecord

AgencyQueryInspectorRecord getAgencyQueryInspectorRecord(Type agencyRecordType)
                                                         throws OperationFailedException

Gets the agency query inspector record corresponding to the given Agency record Type.

Parameters:

agencyRecordType - an agency record type

Returns:

the agency query inspector record

Throws:

NullArgumentException - agencyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agencyRecordType) is false

Compliance:

mandatory - This method must be implemented.