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

Interface	osid.subscription.rules.DispatchConstrainerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.subscription.rules.DispatchConstrainerSearchSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `DispatchConstrainer` objects. The search query is constructed using the `DispatchConstrainerQuery` . This session defines views that offer differing behaviors for searching. federated publisher view: searches include dispatch constrainers in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to dispatch constrainers in this publisher Dispatch constrainers may have a query record indicated by their respective record types. The query record is accessed via the `DispatchQuery` .
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	canSearchDispatchConstrainers
Description	Tests if this user can perform `DispatchConstrainer` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedPublisherView
Description	Federates the view for methods in this session. A federated view will include dispatch constrainers in publishers which are children of this publisher in the publisher hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPublisherView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this publisher only.
Compliance	`mandatory`		This method is 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	getDispatchConstrainersByQuery
Description	Gets a list of `DispatchConstrainers` matching the given search.
Parameters	`osid.subscription.rules.DispatchConstrainerQuery`	`dispatchConstrainerQuery`	the dispatch constrainer query
Return	`osid.subscription.rules.DispatchConstrainerList`		the returned `DispatchConstrainerList`
Errors	NULL_ARGUMENT		`dispatchConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchConstrainerQuery` did not originate from `getDispatchConstrainerQuery()`
Compliance	`mandatory`		This method must be implemented.