OSID - osid.subscription.DispatchQuerySession Service Interface Definition

Interface	osid.subscription.DispatchQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.subscription.DispatchSearchSession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session provides methods for searching `Dispatches`. The search query is constructed using the `DispatchQuery`. The dispatch record `Type` also specifies the record for the dispatch query. Dispatches may have a query record indicated by their respective record types. The query record is accessed via the `DispatchQuery`. The returns in this session may not be cast directly to these interfaces.
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	canSearchDispatches
Description	Tests if this user can perform `Dispatch` 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 opt not to offer search 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 dispatches 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 retrievals to this publisher only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDispatchQuery
Description	Gets a dispatch query.
Return	`osid.subscription.DispatchQuery`		the dispatch query
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchesByQuery
Description	Gets a list of `Dispatches` matching the given dispatch query.
Parameters	`osid.subscription.DispatchQuery`	`dispatchQuery`	the dispatch query
Return	`osid.subscription.DispatchList`		the returned `DispatchList`
Errors	NULL_ARGUMENT		`dispatchQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.