OSID - osid.provisioning.DistributorSearchSession Service Interface Definition

Interface	osid.provisioning.DistributorSearchSession
Implements	`osid.provisioning.DistributorQuerySession`
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` . `getDistributorsByQuery()` is the basic search method and returns a list of `Distributors` . A more advanced search may be performed with `getDistributorsBySearch()` .It accepts a `DistributorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDistributorsBySearch()` returns a `DistributorSearchResults` that can be used to access the resulting `DistributorList` or be used to perform a search within the result set through `DistributorSearch` . Distributors may have a query record indicated by their respective record types. The query record is accessed via the `DistributorQuery` .
Method	getDistributorSearch
Description	Gets a distributor search.
Return	`osid.provisioning.DistributorSearch`		the distributor search
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorSearchOrder
Description	Gets a distributor search order. The `DistributorSearchOrder` is supplied to a `DistributorSearch` to specify the ordering of results.
Return	`osid.provisioning.DistributorSearchOrder`		the distributor search order
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.DistributorQuery`	`distributorQuery`	the distributor query
Parameters	`osid.provisioning.DistributorSearch`	`distributorSearch`	the distributor search
Return	`osid.provisioning.DistributorSearchResults`		the distributor search results
Errors	NULL_ARGUMENT		`distributorQuery` or `distributorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`distributorQuery` or `distributorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorQueryFromInspector
Description	Gets a distributor query from an inspector. The inspector is available from a `DistributorSearchResults` .
Parameters	`osid.provisioning.DistributorQueryInspector`	`distributorQueryInspector`	a distributor query inspector
Return	`osid.provisioning.DistributorQuery`		the distributor query
Errors	NULL_ARGUMENT		`distributorQueryInspector` is `null`
Errors	UNSUPPORTED		`distributorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.