OSID - osid.subscription.SubscriptionSearchSession Service Interface Definition

Interface	osid.subscription.SubscriptionSearchSession
Implements	`osid.subscription.SubscriptionQuerySession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session provides methods for searching `Subscriptions`. The search query is constructed using the `SubscriptionQuery`. The subscription record `Type` also specifies the record for the subscription query. `getSubscriptionsByQuery()` is the basic search method and returns a list of `Publisher` elements. A more advanced search may be performed with `getSubscriptionsBySearch()`. It accepts a `SubscriptionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSubscriptionsBySearch()` returns a `SubscriptionSearchResults` that can be used to access the resulting `SubscriptionList` or be used to perform a search within the result set through `SubscriptionSearch`. Subscriptions may have a query record indicated by their respective record types. The query record is accessed via the `SubscriptionQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getSubscriptionSearch
Description	Gets a subscription search.
Return	`osid.subscription.SubscriptionSearch`		the subscription search
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionSearchOrder
Description	Gets a subscription search order. The `SubscriptionSearchOrder` is supplied to a `SubscriptionSearch` to specify the ordering of results.
Return	`osid.subscription.SubscriptionSearchOrder`		the subscription search order
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsBySearch
Description	Gets the subscription search results matching the given search.
Parameters	`osid.subscription.SubscriptionQuery`	`subscriptionQuery`	the subscription query
Parameters	`osid.subscription.SubscriptionSearch`	`subscriptionSearch`	the subscription search
Return	`osid.subscription.SubscriptionSearchResults`		the subscription search results
Errors	NULL_ARGUMENT		`subscriptionQuery` or `subscriptionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`subscriptionQuery` or `subscriptionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `SubscriptionSearchResults`.
Parameters	`osid.subscription.SubscriptionQueryInspector`	`subscriptionQueryInspector`	a query inspector
Return	`osid.subscription.SubscriptionQuery`		the entry query
Errors	NULL_ARGUMENT		`subscriptionQueryInspector` is `null`
Errors	UNSUPPORTED		`subscriptionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.