OSID - osid.ontology.RelevancyQuery Service Interface Definition

Interface	osid.ontology.RelevancyQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.OsidObjectQuery`
	`osid.ontology.OntologyQuery`
	`osid.ontology.RelevancyQuerySession`
	`osid.ontology.RelevancySearchSession`
	`osid.ontology.RelevancySmartOntologySession`
	`osid.ontology.SubjectQuery`
	`osid.ontology.rules.RelevancyEnablerQuery`
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`.
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	clearSubjectTerms
Description	Clears the subject terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	matchMappedId
Description	Sets the mapped `Id` for this query.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`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 `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	matchOntologyId
Description	Sets the ontology `Id` for this query.
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	clearOntologyIdTerms
Description	Clears the ontology `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyQuery
Description	Tests if an `OntologyQuery` is available for querying ontologies.
Return	`boolean`		`true` if an ontology query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOntologyQuery
Description	Gets the query for an ontology. Multiple retrievals produce a nested `OR` term.
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 `Relevancy` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`relevancytRecordType`	a 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.