OSID - osid.provisioning.rules.BrokerProcessorQuerySession Service Interface Definition

Interface	osid.provisioning.rules.BrokerProcessorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.provisioning.rules.BrokerProcessorSearchSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `BrokerProcessor` objects. The search query is constructed using the `BrokerProcessorQuery` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include broker processors in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to broker processors in this distributor Broker processors may have a query record indicated by their respective record types. The query record is accessed via the `BrokerProcessorQuery` .
Method	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchBrokerProcessors
Description	Tests if this user can perform `BrokerProcessor` 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	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include broker processors in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerProcessorQuery
Description	Gets a broker processor query.
Return	`osid.provisioning.rules.BrokerProcessorQuery`		the broker processor query
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorsByQuery
Description	Gets a list of `BrokerProcessors` matching the given search.
Parameters	`osid.provisioning.rules.BrokerProcessorQuery`	`brokerProcessorQuery`	the broker processor query
Return	`osid.provisioning.rules.BrokerProcessorList`		a broker processor list
Errors	NULL_ARGUMENT		`brokerProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerProcessorQuery` did not originate from `getBrokerProcessorQuery()`
Compliance	`mandatory`		This method must be implemented.