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

Interface	osid.subscription.rules.SubscriptionEnablerSmartPublisherSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic publishers. A `SubscriptionEnablerQuery` can be retrieved from this session and mapped to this `Publisher` to create a virtual collection of subscription enablers. The subscription enablers may be sequenced using the `SubscriptionEnablerSearchOrder` from this session. This `Publisher` has a default query that matches any subscription enabler and a default search order that specifies no sequencing. The queries may be examined using a `SubscriptionEnablerQueryInspector` . The query may be modified by converting the inspector back to a `SubscriptionEnablerQuery` .
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
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	getSubscriptionEnablerQuery
Description	Gets a subscription enabler query.
Return	`osid.subscription.rules.SubscriptionEnablerQuery`		the subscription enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablerSearchOrder
Description	Gets a subscription enabler search order.
Return	`osid.subscription.rules.SubscriptionEnablerSearchOrder`		the subscription enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applySubscriptionEnablerQuery
Description	Applies a subscription enabler query to this publisher.
Parameters	`osid.subscription.rules.SubscriptionEnablerQuery`	`subscriptionEnablerQuery`	the subscription enabler query
Errors	NULL_ARGUMENT		`subscriptionEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`subscriptionEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSubscriptionEnablerQuery
Description	Gets a subscription enabler query inspector for this publisher.
Return	`osid.subscription.rules.SubscriptionEnablerQueryInspector`		the subscription enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySubscriptionEnablerSequencing
Description	Applies a subscription enabler search order to this publisher.
Parameters	`osid.subscription.rules.SubscriptionEnablerSearchOrder`	`subscriptionEnablerSearchOrder`	the subscription enabler search order
Errors	NULL_ARGUMENT		`subscriptionEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`subscriptionEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablerQueryFromInspector
Description	Gets a subscription enabler query from an inspector.
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.