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

Interface	osid.ontology.rules.RelevancyEnablerSearchSession
Implements	`osid.ontology.rules.RelevancyEnablerQuerySession`
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 `RelevancyEnableryQuery` . `getRelevancyEnablersByQuery()` is the basic search method and returns a list of `RelevancyEnablers` . A more advanced search may be performed with `getRelevancyEnablersBySearch()` . It accepts a `RelevancyEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRelevancyEnablersBySearch()` returns a `RelevancyEnablerSearchResults` that can be used to access the resulting `RelevancyEnablerList` or be used to perform a search within the result set through `RelevancyEnablerSearch` . 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 `RelevancyEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `RelevancyEnablerQuery` .
Method	getRelevancyEnablerSearch
Description	Gets a relevancy enabler search.
Return	`osid.ontology.rules.RelevancyEnablerSearch`		the relevancy enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablerSearchOrder
Description	Gets a relevancy enabler search order. The `RelevancyEnablerSearchOrder` is supplied to a `RelevancyEnablerSearch` to specify the ordering of results.
Return	`osid.ontology.rules.RelevancyEnablerSearchOrder`		the relevancy enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.ontology.rules.RelevancyEnablerQuery`	`relevancyEnablerQuery`	the relevancy enabler query
Parameters	`osid.ontology.rules.RelevancyEnablerSearch`	`relevancyEnablerSearch`	the relevancy enabler search
Return	`osid.ontology.rules.RelevancyEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`relevancyEnablerQuery` or `relevancyEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relevancyEnablerQuery` or `relevancyEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyEnablerQueryFromInspector
Description	Gets a relevancy enabler query from an inspector. The inspector is available from a `RelevancyEnablerSearchResults` .
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.