OSID - osid.ontology.rules.RelevancyEnablerSmartOntologySession Service Interface Definition

Interface	osid.ontology.rules.RelevancyEnablerSmartOntologySession
Implements	`osid.OsidSession`
Used By	`osid.ontology.rules.OntologyRulesManager`
Used By	`osid.ontology.rules.OntologyRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic ontologies. A `RelevancyEnablerQuery` can be retrieved from this session and mapped to this `Ontology` to create a virtual collection of relevancy enablers. The relevancy enablers may be sequenced using the `RelevancyEnablerSearchOrder` from this session. This `Ontology` has a default query that matches any relevancy enabler and a default search order that specifies no sequencing. The queries may be examined using a `RelevancyEnablerQueryInspector`. The query may be modified by converting the inspector back to a `RelevancyEnablerQuery`.
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
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 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 operations to unauthorized users.
Return	`boolean`		`false` if smart ontology management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablerQuery
Description	Gets a relevancy enabler query.
Return	`osid.ontology.rules.RelevancyEnablerQuery`		the relevancy enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablerSearchOrder
Description	Gets a relevancy enabler search order.
Return	`osid.ontology.rules.RelevancyEnablerSearchOrder`		the relevancy enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRelevancyEnablerQuery
Description	Applies a relevancy enabler query to this ontology.
Parameters	`osid.ontology.rules.RelevancyEnablerQuery`	`relevancyEnablerQuery`	the relevancy enabler query
Errors	NULL_ARGUMENT		`relevancyEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relevancyEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRelevancyEnablerQuery
Description	Gets a relevancy enabler query inspector for this ontology.
Return	`osid.ontology.rules.RelevancyEnablerQueryInspector`		the relevancy enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRelevancyEnablerSequencing
Description	Applies a relevancy enabler search order to this ontology.
Parameters	`osid.ontology.rules.RelevancyEnablerSearchOrder`	`relevancyEnablerSearchOrder`	the relevancy enabler search order
Errors	NULL_ARGUMENT		`relevancyEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relevancyEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablerQueryFromInspector
Description	Gets a relevancy enabler query from an inspector.
Parameters	`osid.ontology.rules.RelevancyEnablerQueryInspector`	`relevancyEnablerQueryInspector`	a relevancy enabler query inspector
Return	`osid.ontology.rules.RelevancyEnablerQuery`		the relevancy enabler query
Errors	NULL_ARGUMENT		`relevancyEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`relevancyEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.