Interface | osid.search.EngineQueryInspector | ||
---|---|---|---|
Implements | osid.OsidCatalogQueryInspector | ||
Description |
The query inspectors provide a means of accessing the match
terms of a query. These interfaces are used to examine the
actual query terms used in a search or that may be used to
create a smart catalog. Query inspectors may be converted to
| ||
Method | getAncestorEngineIdTerms | ||
Description |
Gets the ancestor engine | ||
Return | osid.search.terms.IdTerm[] | the ancestor engine Id terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorEngineTerms | ||
Description |
Gets the ancestor engine query terms. | ||
Return | osid.search.EngineQueryInspector[] | the ancestor engine terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantEngineIdTerms | ||
Description |
Gets the descendant engine | ||
Return | osid.search.terms.IdTerm[] | the descendant engine Id terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantEngineTerms | ||
Description |
Gets the descendant engine query terms. | ||
Return | osid.search.EngineQueryInspector[] | the descendant engine terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngineQueryInspectorRecord | ||
Description |
Gets the engine query inspector record corresponding to
the given | ||
Parameters | osid.type.Type | engineRecordType | an engine record type |
Return | osid.search.records.EngineQueryInspectorRecord | the engine query inspector record | |
Errors | NULL_ARGUMENT | engineRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(engineRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |