OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.OntologyQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching ontologies. Each method specifies an AND term while multiple invocations of the same method produce 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 a 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.
MethodmatchAnySubject
Description

Matches ontologies that have any subject.

Parametersbooleanmatch true to match ontologies with any subject, false to match ontologies with no subject
CompliancemandatoryThis method must be implemented.
MethodclearSubjectTerms
Description

Clears the subject terms for this query.

CompliancemandatoryThis method must be implemented.
MethodmatchRelevancyId
Description

Sets the relevancy Id for this query.

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

Clears the relevancy Id terms for this query.

CompliancemandatoryThis method must be implemented.
MethodsupportsRelevancyQuery
Description

Tests if a RelevancyQuery is available.

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

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

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

Matches ontologies that have any relevancy.

Parametersbooleanmatch true to match ontologies with any relevancy, false to match ontologies with no relevancy
CompliancemandatoryThis method must be implemented.
MethodclearRelevancyTerms
Description

Clears the relevancy terms for this query.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorOntologyId
Description

Sets the ontology Id for this query to match ontologies that have the specified ontology as an ancestor.

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

Clears the ancestor ontology Id terms for this query.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorOntologyQuery
Description

Tests if an OntologyQuery is available.

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

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

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

Matches ontologies with any ancestor.

Parametersbooleanmatch true to match ontologies with any ancestor, false to match root ontologies
CompliancemandatoryThis method must be implemented.
MethodclearAncestorOntologyTerms
Description

Clears the ancestor ontology terms for this query.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantOntologyId
Description

Sets the ontology Id for this query to match ontologies that have the specified ontology as a descendant.

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

Clears the descendant ontology Id terms for this query.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantOntologyQuery
Description

Tests if an OntologyQuery is available.

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

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

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

Matches ontologies with any descendant.

Parametersbooleanmatch true to match ontologies with any descendant, false to match leaf ontologies
CompliancemandatoryThis method must be implemented.
MethodclearDescendantOntologyTerms
Description

Clears the descendant ontology terms for this query.

CompliancemandatoryThis method must be implemented.
MethodgetOntologyQueryRecord
Description

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

Parametersosid.type.TypeontologyRecordTypea ontology record type
Returnosid.ontology.records.OntologyQueryRecordthe ontology query record
ErrorsNULL_ARGUMENT ontologyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(ontologyRecordType) is false
CompliancemandatoryThis method must be implemented.