OSID - osid.provisioning.RequestSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.RequestSmartDistributorSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RequestQuery` can be retrieved from this session and distributorped to this `Distributor` to create a virtual collection of `Requests`. The requests may be sequenced using the `RequestSearchOrder` from this session. This `Distributor` has a default query that matches any request and a default search order that specifies no sequencing. The queries may be examined using a `RequestQueryInspector`. The query may be modified by converting the inspector back to a `RequestQuery`.
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	canManageSmartDistributors
Description	Tests if this user can manage smart distributors. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart distributor management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequestQuery
Description	Gets a request query.
Return	`osid.provisioning.RequestQuery`		the request query
Compliance	`mandatory`		This method must be implemented.
Method	getRequestSearchOrder
Description	Gets a request search order.
Return	`osid.provisioning.RequestSearchOrder`		the request search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRequestQuery
Description	Applies a request query to this distributor.
Parameters	`osid.provisioning.RequestQuery`	`requestQuery`	the request query
Errors	NULL_ARGUMENT		`requestQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`requestQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRequestQuery
Description	Gets a request query inspector for this distributor.
Return	`osid.provisioning.RequestQueryInspector`		the request query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRequestSequencing
Description	Applies a request search order to this distributor.
Parameters	`osid.provisioning.RequestSearchOrder`	`requestSearchOrder`	the request search order
Errors	NULL_ARGUMENT		`requestSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`requestSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRequestQueryFromInspector
Description	Gets a request query from an inspector.
Parameters	`osid.provisioning.RequestQueryInspector`	`requestQueryInspector`	a request query inspector
Return	`osid.provisioning.RequestQuery`		the request query
Errors	NULL_ARGUMENT		`requestQueryInspector` is `null`
Errors	UNSUPPORTED		`requestQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.