OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancyQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching relevancies. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchSubjectId
Description

Sets the subject Id for this query.

Parametersosid.id.IdsubjectIda subject Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT subjectId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubjectIdTerms
Description

Clears the subject Id terms for this query.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubjectQuery
Description

Tests if a SubjectQuery is available.

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

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

Returnosid.ontology.SubjectQuerythe subject query
ErrorsUNIMPLEMENTED supportsSubjectQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubjectQuery() is true.
MethodclearSubjectTerms
Description

Clears the subject terms for this query.

CompliancemandatoryThis method must be implemented.
MethodmatchMappedId
Description

Sets the mapped Id for this query.

Parametersosid.id.Ididan Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT id is null
CompliancemandatoryThis method must be implemented.
MethodclearMappedIdTerms
Description

Clears the mapped Id terms for this query.

CompliancemandatoryThis method must be implemented.
MethodmatchOntologyId
Description

Sets the ontology Id for this query.

Parametersosid.id.IdontologyIda 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 terms for this query.

CompliancemandatoryThis method must be implemented.
MethodsupportsOntologyQuery
Description

Tests if a OntologyQuery is available for querying ontologies.

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 terms for this query.

CompliancemandatoryThis method must be implemented.
MethodgetRelevancyQueryRecord
Description

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

Parametersosid.type.TyperelevancytRecordTypean relevancy query record type
Returnosid.ontology.records.RelevancyQueryRecordthe relevancy query record
ErrorsNULL_ARGUMENT relevancyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relevancyRecordType) is false
CompliancemandatoryThis method must be implemented.