OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.AgendaQuery
Implementsosid.OsidRuleQuery
Used Byosid.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 AND term while multiple invocations of the same method produce a nested OR.

MethodmatchEngineId
Description

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

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

Clears the engine Id query terms.

Compliancemandatory This method must be implemented.
MethodsupportsEngineQuery
Description

Tests if a EngineQuery is available.

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

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

Returnosid.rules.EngineQuery the engine query
ErrorsUNIMPLEMENTED supportsEngineQuery() is false
Complianceoptional This method must be implemented if supportsEngineQuery() is true.
MethodclearEngineTerms
Description

Clears the engine query terms.

Compliancemandatory This 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.TypeagendaRecordType an agenda record type
Returnosid.rules.check.records.AgendaQueryRecord the agenda query record
ErrorsNULL_ARGUMENT agendaRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(agendaRecordType) is false
Compliancemandatory This method must be implemented.