OSID Specifications
rules check package
Version 3.1.0
rules check package
Version 3.1.0
| Interface | osid.rules.check.InstructionQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
osid.OsidRuleApplicatorQueryInspector | |||
| Used By | osid.rules.check.InstructionSearchResults | ||
osid.rules.check.InstructionSmartEngineSession | |||
| Description |
This is the query inspector for examining instruction queries. | ||
| Method | getAgendaIdTerms | ||
| Description |
Gets the agenda | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgendaTerms | ||
| Description |
Gets the agenda query terms. | ||
| Return | osid.rules.check.AgendaQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCheckIdTerms | ||
| Description |
Gets the check query terms. | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCheckTerms | ||
| Description |
Gets the check query terms. | ||
| Return | osid.rules.check.CheckQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMessageTerms | ||
| Description |
Gets the message query terms. | ||
| Return | osid.search.terms.StringTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWarningTerms | ||
| Description |
Gets the warning query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContinueOnFailTerms | ||
| Description |
Gets the continue-on-fail query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBreakOnSuccessTerms | ||
| Description |
Gets the continue-on-fail query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEngineIdTerms | ||
| Description |
Gets the engine | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEngineTerms | ||
| Description |
Gets the engine query terms. | ||
| Return | osid.rules.EngineQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderTerms | ||
| Description |
Gets the order query terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the order terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstructionQueryInspectorRecord | ||
| Description |
Gets the instruction query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | instructionRecordType | an instruction record type |
| Return | osid.rules.check.records.InstructionQueryInspectorRecord | the instruction query inspector record | |
| Errors | NULL_ARGUMENT | instructionRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(instructionRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |