OSID - osid.ontology.SubjectQuery Service Interface Definition

Interface	osid.ontology.SubjectQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidFederateableQuery`
Description	This is the query for searching subjects. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR.`
Method	matchAncestorSubjectId
Description	Sets the subject `Id` for this query to match subjects that have the specified subject as an ancestor.
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	clearAncestorSubjectIdTerms
Description	Clears the ancestor subject `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorSubjectQuery
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	getAncestorSubjectQuery
Description	Gets the query for a subject. Multiple retrievals produce a nested `OR` term.
Return	`osid.ontology.SubjectQuery`		the subject query
Errors	UNIMPLEMENTED		`supportsAncestorSubjectQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorSubjectQuery()` is `true.`
Method	matchAnyAncestorSubject
Description	Matches subjects with any ancestor.
Parameters	`boolean`	`match`	`true` to match subjects with any ancestor, `false` to match root subjects
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorSubjectTerms
Description	Clears the ancestor subject terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantSubjectId
Description	Sets the subject `Id` for this query to match subjects that have the specified subject as a descendant.
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	clearDescendantSubjectIdTerms
Description	Clears the descendant subject `Id` terms for this query.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantSubjectQuery
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	getDescendantSubjectQuery
Description	Gets the query for a subject. Multiple retrievals produce a nested `OR` term.
Return	`osid.ontology.SubjectQuery`		the subject query
Errors	UNIMPLEMENTED		`supportsDescendantSubjectQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantSubjectQuery()` is `true.`
Method	matchAnyDescendantSubject
Description	Matches subjects with any descendant.
Parameters	`boolean`	`match`	`true` to match subjects with any descendant, `false` to match leaf subjects
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantSubjectTerms
Description	Clears the descendant 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	matchOntologyId
Description	Sets the ontology `Id` for this query.
Parameters	`osid.id.Id`	`ontologyId`	a 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 a `OntologyQuery` is available for querying ontologies.
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 `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	getSubjectQueryRecord
Description	Gets the subject query record corresponding to the given `Subject` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`subjectRecordType`	a subject query record type
Return	`osid.ontology.records.SubjectQueryRecord`		the subject query record
Errors	NULL_ARGUMENT		`subjectRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(subjectRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.