OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.InstructionQueryInspector
Implementsosid.OsidRelationshipQueryInspector
osid.OsidEnablerQueryInspector
Description

This is the query inspector for examining instruction queries.

MethodgetAgendaIdTerms
Description

Gets the agenda Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAgendaTerms
Description

Gets the agenda query terms.

Returnosid.rules.check.AgendaQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetCheckIdTerms
Description

Gets the check query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetCheckTerms
Description

Gets the check query terms.

Returnosid.rules.check.CheckQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetMessageTerms
Description

Gets the message query terms.

Returnosid.search.terms.StringTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetWarningTerms
Description

Gets the warning query terms.

Returnosid.search.terms.BooleanTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetContinueOnFailTerms
Description

Gets the continue-on-fail query terms.

Returnosid.search.terms.BooleanTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEngineIdTerms
Description

Gets the engine Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEngineTerms
Description

Gets the engine query terms.

Returnosid.rules.EngineQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetInstructionQueryInspectorRecord
Description

Gets the instruction query inspector record corresponding to the given Instruction record Type.

Parametersosid.type.TypeinstructionRecordTypean instruction record type
Returnosid.rules.check.records.InstructionQueryInspectorRecordthe instruction query inspector 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.