OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionaryQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining dictionary searches.

MethodgetEntryIdTerms
Description

Gets the entry Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEntryTerms
Description

Gets the entry query terms.

Returnosid.dictionary.EntryQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorDictionaryIdTerms
Description

Gets the ancestor dictionary Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorDictionaryTerms
Description

Gets the ancestor dictionary query terms.

Returnosid.dictionary.DictionaryQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantDictionaryIdTerms
Description

Gets the descendant dictionary Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantDictionaryTerms
Description

Gets the descendant dictionary query terms.

Returnosid.dictionary.DictionaryQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDictionaryQueryInspectorRecord
Description

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

Parametersosid.type.TypedictionaryRecordTypea dictionary record type
Returnosid.dictionary.records.DictionaryQueryInspectorRecordthe dictionary query inspector record
ErrorsNULL_ARGUMENT dictionaryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dictionaryRecordType) is false
CompliancemandatoryThis method must be implemented.