OSID Logo
OSID Specifications
ontology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.rules.RelevancyEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledRelevancyId
Description

Matches enablers mapped to the relevancy.

Parametersosid.id.IdrelevancyIdthe relevancy Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT relevancyId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledRelevancyIdTerms
Description

Clears the relevancy Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledRelevancyQuery
Description

Tests if a RelevancyQuery is available.

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

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

Returnosid.ontology.RelevancyQuerythe relevancy query
ErrorsUNIMPLEMENTED supportsRuledRelevancyQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledRelevancyQuery() is true.
MethodmatchAnyRuledRelevancy
Description

Matches enablers mapped to any relevancy.

Parametersbooleanmatch true for enablers mapped to any relevancy, false to match enablers mapped to no relevancy
CompliancemandatoryThis method must be implemented.
MethodclearRuledRelevancyTerms
Description

Clears the relevancy query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOntologyId
Description

Matches enablers mapped to the ontology.

Parametersosid.id.IdontologyIdthe ontology Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT ontologyId is null
CompliancemandatoryThis method must be implemented.
MethodclearOntologyIdTerms
Description

Clears the ontology Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOntologyQuery
Description

Tests if a OntologyQuery is available.

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

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

Returnosid.ontology.OntologyQuerythe ontology query
ErrorsUNIMPLEMENTED supportsOntologyQuery() is false
ComplianceoptionalThis method must be implemented if supportsOntologyQuery() is true.
MethodclearOntologyTerms
Description

Clears the ontology query terms.

CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerQueryRecord
Description

Gets the relevancy enabler query record corresponding to the given RelevancyEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperelevancyEnablerRecordTypea relevancy enabler record type
Returnosid.ontology.rules.records.RelevancyEnablerQueryRecordthe relevancy enabler query record
ErrorsNULL_ARGUMENT relevancyEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relevancyEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.