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

Interface	osid.ontology.rules.RelevancyEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.ontology.rules.RelevancyEnablerSearchSession`
Used By	`osid.ontology.rules.OntologyRulesManager`
Used By	`osid.ontology.rules.OntologyRulesProxyManager`
Description	This session provides methods for searching among `RelevancyEnabler` objects. The search query is constructed using the `RelevancyEnablerQuery`. This session defines views that offer differing behaviors for searching. federated ontology view: searches include relevancy enablers in ontologies of which this ontology is an ancestor in the ontology hierarchy isolated ontology view: searches are restricted to relevancy enablers in this ontology Relevancy enablers may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchRelevancyEnablers
Description	Tests if this user can perform `RelevancyEnabler` lookups. 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 not offer lookup 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 relevancy enablers in ontologies which are children of this broker 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 lookups to this ontology only.
Compliance	`mandatory`		This method is 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	getRelevancyEnablersByQuery
Description	Gets a list of `RelevancyEnablers` matching the given relevancy enabler query.
Parameters	`osid.ontology.rules.RelevancyEnablerQuery`	`relevancyEnablerQuery`	the relevancy enabler query
Return	`osid.ontology.rules.RelevancyEnablerList`		the returned `RelevancyEnablerList`
Errors	NULL_ARGUMENT		`relevancyEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancyEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.