OSID - osid.ontology.RelevancySearchSession Service Interface Definition

Interface	osid.ontology.RelevancySearchSession
Implements	`osid.ontology.RelevancyQuerySession`
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. `getRelevanciesByQuery()` is the basic search method and returns a list of relevancies. A more advanced search may be performed with `getRelevanciesBySearch()` . It accepts a `RelevancySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRelevanciesBySearch()` returns a `RelevancySearchResults` that can be used to access the resulting `RelevancyList` or be used to perform a search within the result set through `RelevancySearch` . 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	getRelevancySearch
Description	Gets a relevancy search.
Return	`osid.ontology.RelevancySearch`		the relevancy search
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancySearchOrder
Description	Gets a relevancy search order. The `RelevancySearchOrder` is supplied to a `RelevancySearch` to specify the ordering of results.
Return	`osid.ontology.RelevancySearchOrder`		the relevancy search order
Compliance	`mandatory`		This method must be implemented.
Method	getRelevanciesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.ontology.RelevancyQuery`	`relevancyQuery`	the relevancy query
Parameters	`osid.ontology.RelevancySearch`	`relevancySearch`	the relevancy search
Return	`osid.ontology.RelevancySearchResults`		the relevancy search results
Errors	NULL_ARGUMENT		`relevancyQuery` or `relevancySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancySearch` or `relevancyQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyQueryFromInspector
Description	Gets a relevancy query from an inspector. The inspector is available from a `RelevancySearchResults` .
Parameters	`osid.ontology.RelevancyQueryInspector`	`relevancyQueryInspector`	a relevancy query inspector
Return	`osid.ontology.RelevancyQuery`		the relevancy query
Errors	NULL_ARGUMENT		`relevancyQueryInspector` is `null`
Errors	UNSUPPORTED		`relevancyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.