| Interface | osid.dictionary.DictionaryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining dictionary searches. | ||
| Method | getEntryIdTerms | ||
| Description |
Gets the entry | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryTerms | ||
| Description |
Gets the entry query terms. | ||
| Return | osid.dictionary.EntryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorDictionaryIdTerms | ||
| Description |
Gets the ancestor dictionary | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorDictionaryTerms | ||
| Description |
Gets the ancestor dictionary query terms. | ||
| Return | osid.dictionary.DictionaryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantDictionaryIdTerms | ||
| Description |
Gets the descendant dictionary | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantDictionaryTerms | ||
| Description |
Gets the descendant dictionary query terms. | ||
| Return | osid.dictionary.DictionaryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDictionaryQueryInspectorRecord | ||
| Description |
Gets the dictionary query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | dictionaryRecordType | a dictionary record type |
| Return | osid.dictionary.records.DictionaryQueryInspectorRecord | the dictionary query inspector record | |
| Errors | NULL_ARGUMENT | dictionaryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dictionaryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |