OSID - osid.subscription.SubscriptionSmartPublisherSession Service Interface Definition

Interface	osid.subscription.SubscriptionSmartPublisherSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `SubscriptionQuery` can be retrieved from this session and mapped to this `Publisher` to create a virtual collection of `Subscriptions.` The subscriptions may be sequenced using the `SubscriptionSearchOrder` from this session. This `Publisher` has a default query that matches any subscription and a default search order that specifies no sequencing. The queries may be examined using a `SubscriptionQueryInspector.` The query may be modified by converting the inspector back to a `SubscriptionQuery.`
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the `Publisher` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartPublishers
Description	Tests if this user can manage smart publishers. 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 publisher management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionQuery
Description	Gets a subscription query.
Return	`osid.subscription.SubscriptionQuery`		the subscription query
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionSearchOrder
Description	Gets a subscription search order.
Return	`osid.subscription.SubscriptionSearchOrder`		the subscription search order
Compliance	`mandatory`		This method must be implemented.
Method	applySubscriptionQuery
Description	Applies a subscription query to this publisher.
Parameters	`osid.subscription.SubscriptionQuery`	`subscriptionQuery`	the subscription query
Errors	NULL_ARGUMENT		`subscriptionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`subscriptionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSubscriptionQuery
Description	Gets a subscription query inspector for this publisher.
Return	`osid.subscription.SubscriptionQueryInspector`		the subscriptions query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySubscriptionSequencing
Description	Applies a subscription search order to this publisher.
Parameters	`osid.subscription.SubscriptionSearchOrder`	`subscriptionSearchOrder`	the subscription search order
Errors	NULL_ARGUMENT		`subscriptionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`subscriptionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionQueryFromInspector
Description	Gets a subscription query from an inspector.
Parameters	`osid.subscription.SubscriptionQueryInspector`	`subscriptionQueryInspector`	a query inspector
Return	`osid.subscription.SubscriptionQuery`		the subscription query
Errors	NULL_ARGUMENT		`subscriptionQueryInspector` is `null`
Errors	UNSUPPORTED		`subscriptionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.