OSID Specifications
lexicon package
Version 3.0.0
lexicon package
Version 3.0.0
| Interface | osid.lexicon.PressQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Used By | osid.lexicon.IdiomQueryInspector | ||
osid.lexicon.ParameterQueryInspector | |||
osid.lexicon.PressQueryInspector | |||
osid.lexicon.PressSearchResults | |||
osid.lexicon.TextQueryInspector | |||
| Description |
This is the query inspector for examining press 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 | getIdiomIdTerms | ||
| Description |
Gets the idiom | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIdiomTerms | ||
| Description |
Gets the idiom query terms. | ||
| Return | osid.lexicon.IdiomQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterIdTerms | ||
| Description |
Gets the parameter | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterTerms | ||
| Description |
Gets the parameter query terms. | ||
| Return | osid.lexicon.ParameterQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorPressIdTerms | ||
| Description |
Gets the ancestor press | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorPressTerms | ||
| Description |
Gets the ancestor press query terms. | ||
| Return | osid.lexicon.PressQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantPressIdTerms | ||
| Description |
Gets the descendant press | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantPressTerms | ||
| Description |
Gets the descendant press query terms. | ||
| Return | osid.lexicon.PressQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressQueryInspectorRecord | ||
| Description |
Gets the press query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | pressRecordType | a press record type |
| Return | osid.lexicon.records.PressQueryInspectorRecord | the press query inspector record | |
| Errors | NULL_ARGUMENT | pressRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(pressRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |