OSID - osid.subscription.rules.SubscriptionEnablerSearchSession Service Interface Definition

Interface	osid.subscription.rules.SubscriptionEnablerSearchSession
Implements	`osid.subscription.rules.SubscriptionEnablerQuerySession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `SubscriptionEnabler` objects. The search query is constructed using the `SubscriptionEnableryQuery` . `getSubscriptionEnablersByQuery()` is the basic search method and returns a list of `SubscriptionEnablers` . A more advanced search may be performed with `getSubscriptionEnablersBySearch()` . It accepts a `SubscriptionEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSubscriptionEnablersBySearch()` returns a `SubscriptionEnablerSearchResults` that can be used to access the resulting `SubscriptionEnablerList` or be used to perform a search within the result set through `SubscriptionEnablerSearch` . This session defines views that offer differing behaviors for searching. federated subscription view: searches include subscription enablers in subscriptions of which this subscription is an ancestor in the subscription hierarchy isolated subscription view: searches are restricted to subscription enablers in this subscription `SubscriptionEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `SubscriptionEnablerQuery` .
Method	getSubscriptionEnablerSearch
Description	Gets a subscription enabler search.
Return	`osid.subscription.rules.SubscriptionEnablerSearch`		the subscription enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablerSearchOrder
Description	Gets a subscription enabler search order. The `SubscriptionEnablerSearchOrder` is supplied to a `SubscriptionEnablerSearch` to specify the ordering of results.
Return	`osid.subscription.rules.SubscriptionEnablerSearchOrder`		the subscription enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.subscription.rules.SubscriptionEnablerQuery`	`subscriptionEnablerQuery`	the subscription enabler query
Parameters	`osid.subscription.rules.SubscriptionEnablerSearch`	`subscriptionEnablerSearch`	the subscription enabler search
Return	`osid.subscription.rules.SubscriptionEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`subscriptionEnablerQuery` or `subscriptionEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`subscriptionEnablerQuery` or `subscriptionEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablerQueryFromInspector
Description	Gets a subscription enabler query from an inspector. The inspector is available from a `SubscriptionEnablerSearchResults` .
Parameters	`osid.subscription.rules.SubscriptionEnablerQueryInspector`	`subscriptionEnablerQueryInspector`	a subscription enabler query inspector
Return	`osid.subscription.rules.SubscriptionEnablerQuery`		the subscription enabler query
Errors	NULL_ARGUMENT		`subscriptionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`subscriptionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.