OSID Specifications
lexicon package
Version 3.0.0
lexicon package
Version 3.0.0
| Interface | osid.lexicon.IdiomQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Used By | osid.lexicon.IdiomSearchResults | ||
osid.lexicon.IdiomSmartPressSession | |||
osid.lexicon.PressQueryInspector | |||
| Description |
This is the query inspector for examining idiom queries. | ||
| Method | getTextIdTerms | ||
| Description |
Gets the text | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTextTerms | ||
| Description |
Gets the text query terms. | ||
| Return | osid.lexicon.TextQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLanguageTypeTerms | ||
| Description |
Gets the language | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScriptTypeTerms | ||
| Description |
Gets the script | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFormatTypeTerms | ||
| Description |
Gets the format | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTemplateTerms | ||
| Description |
Gets the template query terms. | ||
| Return | osid.search.terms.StringTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressIdTerms | ||
| Description |
Gets the press | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressTerms | ||
| Description |
Gets the press query terms. | ||
| Return | osid.lexicon.PressQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIdiomQueryInspectorRecord | ||
| Description |
Gets the idiom query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | idiomRecordType | an idiom record type |
| Return | osid.lexicon.records.IdiomQueryInspectorRecord | the idiom query inspector record | |
| Errors | NULL_ARGUMENT | idiomRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(idiomRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |