OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.InstructionQuery
Implementsosid.OsidRelationshipQuery
osid.OsidEnablerQuery
Description

This is the query for searching instructions. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchAgendaId
Description

Sets the agenda Id for this query.

Parametersosid.id.IdagendaIdthe agenda Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agendaId is null
CompliancemandatoryThis method must be implemented.
MethodclearAgendaIdTerms
Description

Clears the agenda Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaQuery
Description

Tests if an AgendaQuery is available.

Returnboolean true if an agenda query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgendaQuery
Description

Gets the query for an agenda. Multiple retrievals produce a nested OR term.

Returnosid.rules.check.AgendaQuerythe agenda query
ErrorsUNIMPLEMENTED supportsAgendaQuery() is false
ComplianceoptionalThis method must be implemented if supportsAgendaQuery() is true.
MethodclearAgendaTerms
Description

Clears the agenda query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCheckId
Description

Sets the check Id for this query.

Parametersosid.id.IdcheckIdthe check Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT checkId is null
CompliancemandatoryThis method must be implemented.
MethodclearCheckIdTerms
Description

Clears the check Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCheckQuery
Description

Tests if a CheckQuery is available.

Returnboolean true if a check query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCheckQuery
Description

Gets the query for a check. Multiple retrievals produce a nested OR term.

Returnosid.rules.check.CheckQuerythe check query
ErrorsUNIMPLEMENTED supportsCheckQuery() is false
ComplianceoptionalThis method must be implemented if supportsCheckQuery() is true.
MethodclearCheckTerms
Description

Clears the check query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMessage
Description

Matches messages.

Parametersstringmessagetext to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT message or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyMessage
Description

Matches instructions that have any message.

Parametersbooleanmatch true to match instructions with any message, false to match instructions with no message
CompliancemandatoryThis method must be implemented.
MethodclearMessageTerms
Description

Clears the message query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWarning
Description

Matches warning instructions.

Parametersbooleanmatch true to match warning instructions, false to match hard error instructions
CompliancemandatoryThis method must be implemented.
MethodclearWarningTerms
Description

Clears the warning query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContinueOnFail
Description

Matches continue-on-fail instructions.

Parametersbooleanmatch true to match continue-on-fail instructions, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearContinueOnFailTerms
Description

Clears the continue-on-fail query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEngineId
Description

Sets the engine Id for this query to match instructions assigned to engines.

Parametersosid.id.IdengineIdthe engine Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT engineId is null
CompliancemandatoryThis method must be implemented.
MethodclearEngineIdTerms
Description

Clears the engine Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEngineQuery
Description

Tests if a EngineQuery is available.

Returnboolean true if an engine query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEngineQuery
Description

Gets the query for an engine. Multiple retrievals produce a nested OR term.

Returnosid.rules.EngineQuerythe engine query
ErrorsUNIMPLEMENTED supportsEngineQuery() is false
ComplianceoptionalThis method must be implemented if supportsEngineQuery() is true.
MethodclearEngineTerms
Description

Clears the engine query terms.

CompliancemandatoryThis method must be implemented.
MethodgetInstructionQueryRecord
Description

Gets the instruction query record corresponding to the given Instruction record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeinstructionRecordTypean instruction record type
Returnosid.rules.check.records.InstructionQueryRecordthe instruction query record
ErrorsNULL_ARGUMENT instructionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(instructionRecordType) is false
CompliancemandatoryThis method must be implemented.