OSID Specifications
dictionary package
Version 3.0.0
dictionary package
Version 3.0.0
| Interface | osid.dictionary.EntryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Used By | osid.dictionary.DictionaryQueryInspector | ||
osid.dictionary.EntrySearchResults | |||
osid.dictionary.EntrySmartDictionarySession | |||
| Description |
This is the query inspector for examining entry queries.
Each method specifies an | ||
| Method | getKeyTypeTerms | ||
| Description |
Gets the key type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getKeyTerms | ||
| Description |
Gets the key query terms. | ||
| Return | osid.search.terms.ObjectTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueTypeTerms | ||
| Description |
Gets the value type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueTerms | ||
| Description |
Gets the value query terms. | ||
| Return | osid.search.terms.ObjectTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDictionaryIdTerms | ||
| Description |
Gets the dictionary | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDictionaryTerms | ||
| Description |
Gets the dictionary query terms. | ||
| Return | osid.dictionary.DictionaryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryQueryInspectorRecord | ||
| Description |
Gets the entry query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | entryRecordType | an entry record type |
| Return | osid.dictionary.records.EntryQueryInspectorRecord | the entry query inspector record | |
| Errors | NULL_ARGUMENT | entryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(entryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |