OSID Specifications
rules check package
Version 3.1.0
rules check package
Version 3.1.0
| Interface | osid.rules.check.CheckQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
| Used By | osid.rules.check.CheckSearchResults | ||
osid.rules.check.CheckSmartEngineSession | |||
osid.rules.check.InstructionQueryInspector | |||
| Description |
This is the query inspector for examining check queries. | ||
| Method | getFailCheckTerms | ||
| Description |
Gets the fail check query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeCheckStartDateTerms | ||
| Description |
Gets the time check start date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeCheckEndDateTerms | ||
| Description |
Gets the time check end date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeCheckDateTerms | ||
| Description |
Gets the time check date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeCheckEventIdTerms | ||
| Description |
Gets the event | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeCheckEventTerms | ||
| Description |
Gets the event query terms. | ||
| Return | osid.calendaring.EventQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeCheckCyclicEventIdTerms | ||
| Description |
Gets the cyclic event | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeCheckCyclicEventTerms | ||
| Description |
Gets the cyclic event query terms. | ||
| Return | osid.calendaring.cycle.CyclicEventQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldCheckBlockIdTerms | ||
| Description |
Gets the block | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldCheckBlockTerms | ||
| Description |
Gets the block query terms. | ||
| Return | osid.hold.BlockQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuthorizationCheckFunctionIdTerms | ||
| Description |
Gets the function | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuthorizationCheckFunctionTerms | ||
| Description |
Gets the function query terms. | ||
| Return | osid.authorization.FunctionQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryCheckAuditIdTerms | ||
| Description |
Gets the audit | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryCheckAuditTerms | ||
| Description |
Gets the audit query terms. | ||
| Return | osid.inquiry.AuditQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessCheckAgendaIdTerms | ||
| Description |
Gets the agenda | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessCheckAgendaTerms | ||
| Description |
Gets the agenda query terms. | ||
| Return | osid.rules.check.AgendaQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLoggingCheckTextIdTerms | ||
| Description |
Gets the text | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLoggingCheckTextTerms | ||
| Description |
Gets the text query terms. | ||
| Return | osid.lexicon.TextQueryInspector[] | 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 | getCheckQueryInspectorRecord | ||
| Description |
Gets the check query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | checkRecordType | a check record type |
| Return | osid.rules.check.records.CheckQueryInspectorRecord | the check query inspector record | |
| Errors | NULL_ARGUMENT | checkRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(checkRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |