OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchInstructionId
Description

Sets the instruction Id for this query.

Parametersosid.id.IdqualifierIdthe instruction Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT instructionId is null
CompliancemandatoryThis method must be implemented.
MethodclearInstructionIdTerms
Description

Clears the instruction Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionQuery
Description

Tests if an InstructionQuery is available.

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

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

Returnosid.rules.check.InstructionQuerythe instruction query
ErrorsUNIMPLEMENTED supportsInstructionQuery() is false
ComplianceoptionalThis method must be implemented if supportsInstructionQuery() is true.
MethodmatchAnyInstruction
Description

Matches agendas that have any instruction.

Parametersbooleanmatch true to match agendas with any instruction, false to match agendas with no instruction
CompliancemandatoryThis method must be implemented.
MethodclearInstructionTerms
Description

Clears the instruction query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEngineId
Description

Sets the engine Id for this query to match agendas 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.
MethodgetAgendaQueryRecord
Description

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

Parametersosid.type.TypeagendaRecordTypean agenda record type
Returnosid.rules.check.records.AgendaQueryRecordthe agenda query record
ErrorsNULL_ARGUMENT agendaRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(agendaRecordType) is false
CompliancemandatoryThis method must be implemented.