Interface | osid.ontology.RelevancyQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching relevancies. Each method
match request produces an | ||
Method | matchSubjectId | ||
Description |
Sets the subject | ||
Parameters | osid.id.Id | subjectId | a subject Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | subjectId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubjectIdTerms | ||
Description |
Clears the subject | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSubjectQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a subject query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubjectQuery | ||
Description |
Gets the query for an subject. Multiple retrievals
produce a nested | ||
Return | osid.ontology.SubjectQuery | the subject query | |
Errors | UNIMPLEMENTED | supportsSubjectQuery() is false | |
Compliance | optional | This method must be implemented if supportsSubjectQuery() is
true. | |
Method | clearSubjectTerms | ||
Description |
Clears the subject terms for this query. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMappedId | ||
Description |
Sets the mapped | ||
Parameters | osid.id.Id | id | an Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | id is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMappedIdTerms | ||
Description |
Clears the mapped | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOntologyId | ||
Description |
Sets the ontology | ||
Parameters | osid.id.Id | ontologyId | a 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 terms for this query. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancyQueryRecord | ||
Description |
Gets the relevancy query record corresponding to the
given | ||
Parameters | osid.type.Type | relevancytRecordType | an relevancy query record type |
Return | osid.ontology.records.RelevancyQueryRecord | the relevancy query record | |
Errors | NULL_ARGUMENT | relevancyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(relevancyRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |