OSID - osid.tracking.rules.QueueProcessorQuerySession Service Interface Definition

Interface	osid.tracking.rules.QueueProcessorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.tracking.rules.QueueProcessorSearchSession`
Used By	`osid.tracking.rules.TrackingRulesManager`
Used By	`osid.tracking.rules.TrackingRulesProxyManager`
Description	This session provides methods for searching among `QueueProcessor` objects. The search query is constructed using the `QueueProcessorQuery`. This session defines views that offer differing behaviors for searching. federated front office view: searches include queue processor in front office of which this front office is an ancestor in the front office hierarchy isolated front office view: searches are restricted to queue processor in this office Queue processor may have a query record indicated by their respective record types. The query record is accessed via the `QueueProcessorQuery`.
Method	getFrontOfficeId
Description	Gets the `FrontOffice` `Id` associated with this session.
Return	`osid.id.Id`		the `FrontOffice Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOffice
Description	Gets the `FrontOffice` associated with this session.
Return	`osid.tracking.FrontOffice`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchQueueProcessors
Description	Tests if this user can perform `QueueProcessor` lookups. 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	useFederatedFrontOfficeView
Description	Federates the view for methods in this session. A federated view will include queue processor in front offices which are children of this queue in the front office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFrontOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this front office only.
Compliance	`mandatory`		This method is must be implemented.
Method	getQueueProcessorQuery
Description	Gets a queue processor query.
Return	`osid.tracking.rules.QueueProcessorQuery`		the queue processor query
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorsByQuery
Description	Gets a list of `QueueProcessors` matching the given queue processor query.
Parameters	`osid.tracking.rules.QueueProcessorQuery`	`queueProcessorQuery`	the queue processor query
Return	`osid.tracking.rules.QueueProcessorList`		the returned `QueueProcessorList`
Errors	NULL_ARGUMENT		`queueProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueProcessorQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.