OSID - osid.ontology.RelevancySmartOntologySession Service Interface Definition

Interface	osid.ontology.RelevancySmartOntologySession
Implements	`osid.OsidSession`
Used By	`osid.ontology.OntologyManager`
Used By	`osid.ontology.OntologyProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RelevancyQuery` can be retrieved from this session and mapped to this `Ontology` to create a virtual collection of `Relevancies`. The entries may be sequenced using the `RelevancySearchOrder` from this session. This `Ontology` has a default query that matches any relevancy and a default search order that specifies no sequencing. The queries may be examined using a `RelevancyQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartOntologies
Description	Tests if this user can manage smart ontologies. 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 smart operations.
Return	`boolean`		`false` if smart ontology methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getRelevancySearchOrder
Description	Gets a relevancy search order.
Return	`osid.ontology.RelevancySearchOrder`		the relevancy search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRelevancyQuery
Description	Applies a relevancy query to this ontology.
Parameters	`osid.ontology.RelevancyQuery`	`relevancyQuery`	the relevancy query
Errors	NULL_ARGUMENT		`relevancyQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relevancyQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRelevancyQuery
Description	Gets a relevancy query inspector for this ontology.
Return	`osid.ontology.RelevancyQueryInspector`		the relevancy query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRelevancySequencing
Description	Applies a relevancy search order to this ontology.
Parameters	`osid.ontology.RelevancySearchOrder`	`relevancySearchOrder`	the relevancy search order
Errors	NULL_ARGUMENT		`relevancySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relevancySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyQueryFromInspector
Description	Gets a relevancy query from an inspector.
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.