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

Interface	osid.subscription.rules.DispatchProcessorSmartPublisherSession
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 `DispatchProcessorQuery` can be retrieved from this session and mapped to this `Publisher` to create a virtual collection of `DispatchProcessors` . The dispatch processors may be sequenced using the `DispatchProcessorSearchOrder` from this session. This `Publisher` has a default query that matches any dispatch processor and a default search order that specifies no sequencing. The queries may be examined using a `DispatchProcessorQueryInspector` . The query may be modified by converting the inspector back to a `DispatchProcessorQuery` .
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	getDispatchProcessorQuery
Description	Gets a dispatch processor query.
Return	`osid.subscription.rules.DispatchProcessorQuery`		the dispatch processor query
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorSearchOrder
Description	Gets a dispatch processor search order.
Return	`osid.subscription.rules.DispatchProcessorSearchOrder`		the dispatch processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchProcessorQuery
Description	Applies a dispatch processor query to this publisher.
Parameters	`osid.subscription.rules.DispatchProcessorQuery`	`dispatchProcessorQuery`	the dispatch processor query
Errors	NULL_ARGUMENT		`dispatchProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDispatchProcessorQuery
Description	Gets a dispatch processor query inspector for this publisher.
Return	`osid.subscription.rules.DispatchProcessorQueryInspector`		the dispatch processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchProcessorSequencing
Description	Applies a dispatch processor search order to this publisher.
Parameters	`osid.subscription.rules.DispatchProcessorSearchOrder`	`dispatchProcessorSearchOrder`	the dispatch processor search order
Errors	NULL_ARGUMENT		`dispatchProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorQueryFromInspector
Description	Gets a dispatch processor query from an inspector.
Parameters	`osid.subscription.rules.DispatchProcessorQueryInspector`	`dispatchProcessorQueryInspector`	a dispatch processor query inspector
Return	`osid.subscription.rules.DispatchProcessorQuery`		the dispatch processor query
Errors	NULL_ARGUMENT		`dispatchProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.