| Interface | osid.rules.EngineQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description | 
                 This is the query inspector for examining engine queries.  | ||
| Method | getRuleIdTerms | ||
| Description | 
                     Gets the rule   | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuleTerms | ||
| Description | 
                     Gets the rule query terms.  | ||
| Return | osid.rules.RuleQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorEngineIdTerms | ||
| Description | 
                     Gets the ancestor engine   | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorEngineTerms | ||
| Description | 
                     Gets the ancestor engine query terms.  | ||
| Return | osid.rules.EngineQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantEngineIdTerms | ||
| Description | 
                     Gets the descendant engine   | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantEngineTerms | ||
| Description | 
                     Gets the descendant engine query terms.  | ||
| Return | osid.rules.EngineQueryInspector[] | the query 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.rules.records.EngineQueryInspectorRecord | the engine query inspector record | |
| Errors | NULL_ARGUMENT |  engineRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(engineRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |