OSID - osid.provisioning.BrokerQuerySession Service Interface Definition

Interface	osid.provisioning.BrokerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.provisioning.BrokerSearchSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `Broker` objects. The search query is constructed using the `BrokerQuery`. This session defines views that offer differing behaviors for searching. federated distributor view: searches include brokers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to brokers in this distributor Brokers may have a query record indicated by their respective record types. The query record is accessed via the `BrokerQuery`.
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	canSearchBrokers
Description	Tests if this user can perform `Broker` 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	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include brokers 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	getBrokerQuery
Description	Gets a broker query.
Return	`osid.provisioning.BrokerQuery`		the broker query
Compliance	`mandatory`		This method must be implemented.
Method	getBrokersByQuery
Description	Gets a list of `Brokers` matching the given broker query.
Parameters	`osid.provisioning.BrokerQuery`	`brokerQuery`	the broker query
Return	`osid.provisioning.BrokerList`		the returned `BrokerList`
Errors	NULL_ARGUMENT		`brokerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.