Interface | osid.ontology.rules.RelevancyEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching relevancy enablers. Each
method match specifies an | ||
Method | matchRuledRelevancyId | ||
Description |
Matches enablers mapped to the relevancy. | ||
Parameters | osid.id.Id | relevancyId | the relevancy Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | relevancyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledRelevancyIdTerms | ||
Description |
Clears the relevancy | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledRelevancyQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a relevancy query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledRelevancyQuery | ||
Description |
Gets the query for a relevancy. Multiple retrievals
produce a nested | ||
Return | osid.ontology.RelevancyQuery | the relevancy query | |
Errors | UNIMPLEMENTED | supportsRuledRelevancyQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledRelevancyQuery()
is true. | |
Method | matchAnyRuledRelevancy | ||
Description |
Matches enablers mapped to any relevancy. | ||
Parameters | boolean | match | true for enablers mapped to any relevancy, false
to match enablers mapped to no relevancy |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledRelevancyTerms | ||
Description |
Clears the relevancy query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOntologyId | ||
Description |
Matches enablers mapped to the ontology. | ||
Parameters | osid.id.Id | ontologyId | the ontology Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | ontologyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearOntologyIdTerms | ||
Description |
Clears the ontology | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsOntologyQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a ontology query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOntologyQuery | ||
Description |
Gets the query for a ontology. Multiple retrievals
produce a nested | ||
Return | osid.ontology.OntologyQuery | the ontology query | |
Errors | UNIMPLEMENTED | supportsOntologyQuery() is false | |
Compliance | optional | This method must be implemented if supportsOntologyQuery()
is true. | |
Method | clearOntologyTerms | ||
Description |
Clears the ontology query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancyEnablerQueryRecord | ||
Description |
Gets the relevancy enabler query record corresponding
to the given | ||
Parameters | osid.type.Type | relevancyEnablerRecordType | a relevancy enabler record type |
Return | osid.ontology.rules.records.RelevancyEnablerQueryRecord | the relevancy enabler query record | |
Errors | NULL_ARGUMENT | relevancyEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(relevancyEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |