Interface | osid.rules.check.InstructionQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
osid.OsidEnablerQuery | |||
Description |
This is the query for searching instructions. Each method
match specifies an | ||
Method | matchAgendaId | ||
Description |
Sets the agenda | ||
Parameters | osid.id.Id | agendaId | the agenda Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agendaId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAgendaIdTerms | ||
Description |
Clears the agenda | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAgendaQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agenda query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgendaQuery | ||
Description |
Gets the query for an agenda. Multiple retrievals
produce a nested | ||
Return | osid.rules.check.AgendaQuery | the agenda query | |
Errors | UNIMPLEMENTED | supportsAgendaQuery() is false | |
Compliance | optional | This method must be implemented if supportsAgendaQuery() is
true. | |
Method | clearAgendaTerms | ||
Description |
Clears the agenda query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCheckId | ||
Description |
Sets the check | ||
Parameters | osid.id.Id | checkId | the check Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | checkId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCheckIdTerms | ||
Description |
Clears the check | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCheckQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a check query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCheckQuery | ||
Description |
Gets the query for a check. Multiple retrievals produce
a nested | ||
Return | osid.rules.check.CheckQuery | the check query | |
Errors | UNIMPLEMENTED | supportsCheckQuery() is false | |
Compliance | optional | This method must be implemented if supportsCheckQuery() is
true. | |
Method | clearCheckTerms | ||
Description |
Clears the check query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMessage | ||
Description |
Matches messages. | ||
Parameters | string | message | text to match |
osid.type.Type | stringMatchType | the string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | message or stringMatchType is null | |
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyMessage | ||
Description |
Matches instructions that have any message. | ||
Parameters | boolean | match | true to match instructions with any message, false
to match instructions with no message |
Compliance | mandatory | This method must be implemented. | |
Method | clearMessageTerms | ||
Description |
Clears the message query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWarning | ||
Description |
Matches warning instructions. | ||
Parameters | boolean | match | true to match warning instructions, false to
match hard error instructions |
Compliance | mandatory | This method must be implemented. | |
Method | clearWarningTerms | ||
Description |
Clears the warning query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchContinueOnFail | ||
Description |
Matches continue-on-fail instructions. | ||
Parameters | boolean | match | true to match continue-on-fail instructions, false
otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearContinueOnFailTerms | ||
Description |
Clears the continue-on-fail query terms. | ||
Compliance | mandatory | This method must be implemented. | |
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 | getInstructionQueryRecord | ||
Description |
Gets the instruction query record corresponding to the
given | ||
Parameters | osid.type.Type | instructionRecordType | an instruction record type |
Return | osid.rules.check.records.InstructionQueryRecord | the instruction query 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. |