OSID - osid.ontology.OntologyQuery Service Interface Definition

Interface	osid.ontology.OntologyQuery
Implements	`osid.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.`
Method	matchSubjectId
Description	Sets the subject `Id` for this query.
Parameters	`osid.id.Id`	`subjectId`	a subject `Id`
Parameters	`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 `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectQuery
Description	Tests if a `SubjectQuery` is available.
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 a subject. Multiple retrievals produce a nested `OR` term.
Return	`osid.ontology.SubjectQuery`		the subject query
Errors	UNIMPLEMENTED		`supportsSubjectQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubjectQuery()` is `true.`
Method	matchAnySubject
Description	Matches ontologies that have any subject.
Parameters	`boolean`	`match`	`true` to match ontologies with any subject, `false` to match ontologies with no subject
Compliance	`mandatory`		This method must be implemented.
Method	clearSubjectTerms
Description	Clears the subject terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	matchRelevancyId
Description	Sets the relevancy `Id` for this query.
Parameters	`osid.id.Id`	`relevancyId`	a relevancy `Id`
Parameters	`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	clearRelevancyIdTerms
Description	Clears the relevancy `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyQuery
Description	Tests if a `RelevancyQuery` is available.
Return	`boolean`		`true` if a relevancy query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyQuery
Description	Gets the query for a relevancy. Multiple retrievals produce a nested `OR` term.
Return	`osid.ontology.RelevancyQuery`		the relevancy query
Errors	UNIMPLEMENTED		`supportsRelevancyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelevancyQuery()` is `true.`
Method	matchAnyRelevancy
Description	Matches ontologies that have any relevancy.
Parameters	`boolean`	`match`	`true` to match ontologies with any relevancy, `false` to match ontologies with no relevancy
Compliance	`mandatory`		This method must be implemented.
Method	clearRelevancyTerms
Description	Clears the relevancy terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorOntologyId
Description	Sets the ontology `Id` for this query to match ontologies that have the specified ontology as an ancestor.
Parameters	`osid.id.Id`	`ontologyId`	an ontology `Id`
Parameters	`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	clearAncestorOntologyIdTerms
Description	Clears the ancestor ontology `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorOntologyQuery
Description	Tests if an `OntologyQuery` is available.
Return	`boolean`		`true` if an ontology query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorOntologyQuery
Description	Gets the query for an ontology. Multiple retrievals produce a nested `OR` term.
Return	`osid.ontology.OntologyQuery`		the ontology query
Errors	UNIMPLEMENTED		`supportsAncestorOntologyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorOntologyQuery()` is `true.`
Method	matchAnyAncestorOntology
Description	Matches ontologies with any ancestor.
Parameters	`boolean`	`match`	`true` to match ontologies with any ancestor, `false` to match root ontologies
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorOntologyTerms
Description	Clears the ancestor ontology terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantOntologyId
Description	Sets the ontology `Id` for this query to match ontologies that have the specified ontology as a descendant.
Parameters	`osid.id.Id`	`ontologyId`	an ontology `Id`
Parameters	`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	clearDescendantOntologyIdTerms
Description	Clears the descendant ontology `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantOntologyQuery
Description	Tests if an `OntologyQuery` is available.
Return	`boolean`		`true` if an ontology query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantOntologyQuery
Description	Gets the query for an ontology. Multiple retrievals produce a nested `OR` term.
Return	`osid.ontology.OntologyQuery`		the ontology query
Errors	UNIMPLEMENTED		`supportsDescendantOntologyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantOntologyQuery()` is `true.`
Method	matchAnyDescendantOntology
Description	Matches ontologies with any descendant.
Parameters	`boolean`	`match`	`true` to match ontologies with any descendant, `false` to match leaf ontologies
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantOntologyTerms
Description	Clears the descendant ontology terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	getOntologyQueryRecord
Description	Gets the ontology query record corresponding to the given `Ontology` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`ontologyRecordType`	a ontology record type
Return	`osid.ontology.records.OntologyQueryRecord`		the ontology query record
Errors	NULL_ARGUMENT		`ontologyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(ontologyRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.