OSID - osid.provisioning.DistributorQuerySession Service Interface Definition

Interface	osid.provisioning.DistributorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.provisioning.DistributorSearchSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `Distributor` objects. The search query is constructed using the `DistributorQuery` . Distributors may have a query record indicated by their respective record types. The query record is accessed via the `DistributorQuery` .
Method	canSearchDistributors
Description	Tests if this user can perform `Distributor` 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	getDistributorQuery
Description	Gets a distributor query.
Return	`osid.provisioning.DistributorQuery`		the distributor query
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorsByQuery
Description	Gets a list of `Distributors` matching the given distributor query.
Parameters	`osid.provisioning.DistributorQuery`	`distributorQuery`	the distributor query
Return	`osid.provisioning.DistributorList`		the returned `DistributorList`
Errors	NULL_ARGUMENT		`distributorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`distributorQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.