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

Interface	osid.subscription.rules.DispatchProcessorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.subscription.rules.DispatchProcessorSearchSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for searching among `DispatchProcessor` objects. The search query is constructed using the `DispatchProcessorQuery` . This session defines views that offer differing behaviors for searching. federated publisher view: searches include dispatch processors in publishers of which this publisher is an ancestor in the publisher hierarchy isolated publisher view: searches are restricted to dispatch processors in this publisher Dispatch processors 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	canSearchDispatchProcessors
Description	Tests if this user can perform `DispatchProcessor` 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 processors 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	getDispatchProcessorQuery
Description	Gets a dispatch processor query.
Return	`osid.subscription.rules.DispatchProcessorQuery`		the dispatch processor query
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorsByQuery
Description	Gets a list of `DispatchProcessors` matching the given search.
Parameters	`osid.subscription.rules.DispatchProcessorQuery`	`dispatchProcessorQuery`	the dispatch processor query
Return	`osid.subscription.rules.DispatchProcessorList`		the dispatch processor list
Errors	NULL_ARGUMENT		`dispatchProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchProcessorQuery` did not originate from `getDispatchProcessorQuery()`
Compliance	`mandatory`		This method must be implemented.