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

Interface	osid.subscription.rules.DispatchConstrainerSmartPublisherSession
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 `DispatchConstrainerQuery` can be retrieved from this session and mapped to this `Publisher` to create a virtual collection of `DispatchConstrainers` . The dispatch constrainers may be sequenced using the `DispatchConstrainerSearchOrder` from this session. This `Publisher` has a default query that matches any dispatch constrainer and a default search order that specifies no sequencing. The queries may be examined using a `DispatchConstrainerQueryInspector` . The query may be modified by converting the inspector back to a `DispatchConstrainerQuery` .
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	getDispatchConstrainerQuery
Description	Gets a dispatch constrainer query.
Return	`osid.subscription.rules.DispatchConstrainerQuery`		the dispatch constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerSearchOrder
Description	Gets a dispatch constrainer search order.
Return	`osid.subscription.rules.DispatchConstrainerSearchOrder`		the dispatch constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchConstrainerQuery
Description	Applies a dispatch constrainer query to this publisher.
Parameters	`osid.subscription.rules.DispatchConstrainerQuery`	`dispatchConstrainerQuery`	the dispatch constrainer query
Errors	NULL_ARGUMENT		`dispatchConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDispatchConstrainerQuery
Description	Gets a dispatch constrainer query inspector for this publisher.
Return	`osid.subscription.rules.DispatchConstrainerQueryInspector`		the dispatch constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDispatchConstrainerSequencing
Description	Applies a dispatch constrainer search order to this publisher.
Parameters	`osid.subscription.rules.DispatchConstrainerSearchOrder`	`dispatchConstrainerSearchOrder`	the dispatch constrainer search order
Errors	NULL_ARGUMENT		`dispatchConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`dispatchConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerQueryFromInspector
Description	Gets a dispatch constrainer query from an inspector.
Parameters	`osid.subscription.rules.DispatchConstrainerQueryInspector`	`dispatchConstrainerQueryInspector`	a dispatch constrainer query inspector
Return	`osid.subscription.rules.DispatchConstrainerQuery`		the dispatch constrainer query
Errors	NULL_ARGUMENT		`dispatchConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`dispatchConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.