org.osid.dictionary

Interface DictionaryQueryInspector

All Superinterfaces:

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

public interface DictionaryQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining dictionary searches.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorDictionaryIdTerms() Gets the ancestor dictionary Id query terms.
DictionaryQueryInspector[]	getAncestorDictionaryTerms() Gets the ancestor dictionary query terms.
IdTerm[]	getDescendantDictionaryIdTerms() Gets the descendant dictionary Id query terms.
DictionaryQueryInspector[]	getDescendantDictionaryTerms() Gets the descendant dictionary query terms.
DictionaryQueryInspectorRecord	getDictionaryQueryInspectorRecord(Type dictionaryRecordType) Gets the dictionary query inspector record corresponding to the given Dictionary record Type.
IdTerm[]	getEntryIdTerms() Gets the entry Id query terms.
EntryQueryInspector[]	getEntryTerms() Gets the entry query 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

getEntryIdTerms

IdTerm[] getEntryIdTerms()

Gets the entry Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEntryTerms

EntryQueryInspector[] getEntryTerms()

Gets the entry query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorDictionaryIdTerms

IdTerm[] getAncestorDictionaryIdTerms()

Gets the ancestor dictionary Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorDictionaryTerms

DictionaryQueryInspector[] getAncestorDictionaryTerms()

Gets the ancestor dictionary query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantDictionaryIdTerms

IdTerm[] getDescendantDictionaryIdTerms()

Gets the descendant dictionary Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantDictionaryTerms

DictionaryQueryInspector[] getDescendantDictionaryTerms()

Gets the descendant dictionary query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDictionaryQueryInspectorRecord

DictionaryQueryInspectorRecord getDictionaryQueryInspectorRecord(Type dictionaryRecordType)
                                                                 throws OperationFailedException

Gets the dictionary query inspector record corresponding to the given Dictionary record Type.

Parameters:

dictionaryRecordType - a dictionary record type

Returns:

the dictionary query inspector record

Throws:

NullArgumentException - dictionaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dictionaryRecordType) is false

Compliance:

mandatory - This method must be implemented.