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

Interface	osid.subscription.rules.DispatchEnablerSmartPublisherSession
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 catalogs. A `DispatchEnablerQuery` can be retrieved from this session and mapped to this `Publisher` to create a virtual collection of `DispatchEnablers` . The dispatch enablers may be sequenced using the `DispatchEnablerSearchOrder` from this session. This `Publisher` has a default query that matches any dispatch enabler and a default search order that specifies no sequencing. The queries may be examined using a `DispatchEnablerQueryInspector` . The query may be modified by converting the inspector back to a `DispatchEnablerQuery` .
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	getDispatchEnablerQuery
Description	Gets a dispatch enabler query.
Return	`osid.subscription.rules.DispatchEnablerQuery`		the dispatch enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablerSearchOrder
Description	Gets a dispatch enabler search order.
Return	`osid.subscription.rules.DispatchEnablerSearchOrder`		the dispatch enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchEnablerQuery
Description	Applies a dispatch enabler query to this publisher.
Parameters	`osid.subscription.rules.DispatchEnablerQuery`	`dispatchEnablerQuery`	the dispatch enabler query
Errors	NULL_ARGUMENT		`dispatchEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDispatchEnablerQuery
Description	Gets a dispatch enabler query inspector for this publisher.
Return	`osid.subscription.rules.DispatchEnablerQueryInspector`		the dispatch enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchEnablerSequencing
Description	Applies a dispatch enabler search order to this publisher.
Parameters	`osid.subscription.rules.DispatchEnablerSearchOrder`	`dispatchEnablerSearchOrder`	the dispatch enabler search order
Errors	NULL_ARGUMENT		`dispatchEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablerQueryFromInspector
Description	Gets a dispatch enabler query from an inspector.
Parameters	`osid.subscription.rules.DispatchEnablerQueryInspector`	`dispatchEnablerQueryInspector`	a dispatch enabler query inspector
Return	`osid.subscription.DispatchQuery`		the dispatch enabler query
Errors	NULL_ARGUMENT		`dispatchEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.