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

Interface	osid.subscription.rules.DispatchConstrainerEnablerSmartPublisherSession
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 `DispatchConstrainerEnablerQuery` can be retrieved from this session and mapped to this `Publisher` to create a virtual collection of `DispatchConstrainerEnablers`. The dispatch constrainer enablers may be sequenced using the `DispatchConstrainerEnablerSearchOrder` from this session. This `Publisher` has a default query that matches any dispatch constrainer enabler and a default search order that specifies no sequencing. The queries may be examined using a `DispatchConstrainerEnablerQueryInspector`. The query may be modified by converting the inspector back to a `DispatchConstrainerEnablerQuery`.
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	getDispatchConstrainerEnablerQuery
Description	Gets a dispatch constrainer enabler query.
Return	`osid.subscription.rules.DispatchConstrainerEnablerQuery`		the dispatch constrainer enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerEnablerSearchOrder
Description	Gets a dispatch constrainer enabler search order.
Return	`osid.subscription.rules.DispatchEnablerSearchOrder`		the dispatch constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchConstrainerEnablerQuery
Description	Applies a dispatch constrainer enabler query to this publisher.
Parameters	`osid.subscription.rules.DispatchConstrainerEnablerQuery`	`dispatchConstrainerEnablerQuery`	the dispatch constrainer enabler query
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchConstrainerEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDispatchConstrainerEnablerQuery
Description	Gets a dispatch constrainer enabler query inspector for this publisher.
Return	`osid.subscription.rules.DispatchConstrainerEnablerQueryInspector`		the dispatch constrainer enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchConstrainerEnablerSequencing
Description	Applies a dispatch constrainer enabler search order to this publisher.
Parameters	`osid.subscription.rules.DispatchConstrainerEnablerSearchOrder`	`dispatchConstrainerEnablerSearchOrder`	the dispatch constrainer enabler search order
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchConstrainerEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerEnablerQueryFromInspector
Description	Gets a dispatch constrainer enabler query from an inspector.
Parameters	`osid.subscription.rules.DispatchConstrainerEnablerQueryInspector`	`dispatchConstrainerEnablerQueryInspector`	a dispatch constrainer enabler query inspector
Return	`osid.subscription.rules.DispatchConstrainerEnablerQuery`		the dispatch constrainer enabler query
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.