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

Interface	osid.subscription.rules.DispatchProcessorEnablerSmartPublisherSession
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 `DispatchProcessorEnablerQuery` can be retrieved from this session and mapped to this `Publisher` to create a virtual collection of `DispatchProcessorEnablers` . The dispatch processor enablers may be sequenced using the `DispatchProcessorEnablerSearchOrder` from this session. This `Publisher` has a default query that matches any dispatch processor enabler and a default search order that specifies no sequencing. The queries may be examined using a `DispatchProcessorEnablerQueryInspector` . The query may be modified by converting the inspector back to a `DispatchProcessorEnablerQuery` .
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	getDispatchProcessorEnablerQuery
Description	Gets a dispatch processor enabler query.
Return	`osid.subscription.rules.DispatchProcessorEnablerQuery`		the dispatch processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorEnablerSearchOrder
Description	Gets a dispatch processor enabler search order.
Return	`osid.subscription.rules.DispatchProcessorEnablerSearchOrder`		the dispatch processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchProcessorEnablerQuery
Description	Applies a dispatch processor enabler query to this publisher.
Parameters	`osid.subscription.rules.DispatchProcessorEnablerQuery`	`dispatchProcessorEnablerQuery`	the dispatch processot enabler query
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDispatchProcessorEnablerQuery
Description	Gets a dispatch processor enabler query inspector for this publisher.
Return	`osid.subscription.rules.DispatchProcessorEnablerQueryInspector`		the dispatch processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchProcessorEnablerSequencing
Description	Applies a dispatch processor enabler search order to this publisher.
Parameters	`osid.subscription.rules.DispatchProcessorEnablerSearchOrder`	`dispatchProcessorEnablerSearchOrder`	the dispatch processor enabler search order
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorEnablerQueryFromInspector
Description	Gets a dispatch processor enabler query from an inspector.
Parameters	`osid.subscription.rules.DispatchProcessorEnablerQueryInspector`	`dispatchProcessorEnablerQueryInspector`	a dispatch processor enabler query inspector
Return	`osid.subscription.rules.DispatchProcessorEnablerQuery`		the dispatch processor enabler query
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.