OSID - osid.ontology.RelevancyQuerySession Service Interface Definition

Interface	osid.ontology.RelevancyQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.ontology.RelevancySearchSession`
Used By	`osid.ontology.OntologyManager`
Used By	`osid.ontology.OntologyProxyManager`
Description	This session provides methods for searching `Relevancy` objects. The search query is constructed using the `RelevancyQuery`. The relevancy record `Type` also specifies the record for the relevancy query. This session defines views that offer differing behaviors for searching. federated ontology view: searches include relevancies in ontologies of which this ontology is an ancestor in the ontology hierarchy isolated ontology view: searches are restricted Relevancies may have a query record indicated by their respective record types. The query record is accessed via the `RelevancyQuery`.
Method	getOntologyId
Description	Gets the `Ontology` `Id` associated with this session.
Return	`osid.id.Id`		the `Ontology Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOntology
Description	Gets the `Ontology` associated with this session.
Return	`osid.ontology.Ontology`		the `Ontology` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchRelevancies
Description	Tests if this user can perform `Relevancy` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedOntologyView
Description	Federates the view for methods in this session. A federated view will include relevancies in ontologies which are children of this ontology in the ontology hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOntologyView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this ontology only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRelevancyQuery
Description	Gets a relevancy query.
Return	`osid.ontology.RelevancyQuery`		the relevancy query
Compliance	`mandatory`		This method must be implemented.
Method	getRelevanciesByQuery
Description	Gets a list of relevancies matching the given relevancy query.
Parameters	`osid.ontology.RelevancyQuery`	`relevancyQuery`	the relevancy query
Return	`osid.ontology.RelevancyList`		the returned `RelevancyList`
Errors	NULL_ARGUMENT		`relevancyQuery is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancyQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.