| Interface | osid.rules.check.AgendaQuery | ||
|---|---|---|---|
| Implements | osid.OsidRuleQuery | ||
| Used By | osid.rules.check.AgendaQuerySession | ||
osid.rules.check.AgendaSearchSession | |||
osid.rules.check.AgendaSmartEngineSession | |||
osid.rules.check.CheckQuery | |||
osid.rules.check.InstructionQuery | |||
| Description |
This is the query for searching agendas. Each method match
specifies an | ||
| Method | matchEngineId | ||
| Description |
Sets the engine | ||
| Parameters | osid.id.Id | engineId | the engine Id |
boolean | match | true for a positive match, false for a negative
match | |
| Errors | NULL_ARGUMENT | engineId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearEngineIdTerms | ||
| Description |
Clears the engine | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsEngineQuery | ||
| Description |
Tests if a | ||
| Return | boolean | true if an engine query is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEngineQuery | ||
| Description |
Gets the query for an engine. Multiple retrievals
produce a nested | ||
| Return | osid.rules.EngineQuery | the engine query | |
| Errors | UNIMPLEMENTED | supportsEngineQuery() is false | |
| Compliance | optional | This method must be implemented if supportsEngineQuery() is
true. | |
| Method | clearEngineTerms | ||
| Description |
Clears the engine query terms. | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgendaQueryRecord | ||
| Description |
Gets the agenda query record corresponding to the
given | ||
| Parameters | osid.type.Type | agendaRecordType | an agenda record type |
| Return | osid.rules.check.records.AgendaQueryRecord | the agenda query record | |
| Errors | NULL_ARGUMENT | agendaRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(agendaRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |