OSID - osid.provisioning.ProvisionSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.ProvisionSmartDistributorSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProvisionQuery` can be retrieved from this session and distributorped to this `Distributor` to create a virtual collection of `Provisions` . The provisions may be sequenced using the `ProvisionSearchOrder` from this session. This `Distributor` has a default query that matches any provision and a default search order that specifies no sequencing. The queries may be examined using a `ProvisionQueryInspector` . The query may be modified by converting the inspector back to a `ProvisionQuery` .
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	getProvisionQuery
Description	Gets a provision query.
Return	`osid.provisioning.ProvisionQuery`		the provision query
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionSearchOrder
Description	Gets a provision search order.
Return	`osid.provisioning.ProvisionSearchOrder`		the provision search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProvisionQuery
Description	Applies a provision query to this distributor.
Parameters	`osid.provisioning.ProvisionQuery`	`provisionQuery`	the provision query
Errors	NULL_ARGUMENT		`provisionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`provisionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProvisionQuery
Description	Gets a provision query inspector for this distributor.
Return	`osid.provisioning.ProvisionQueryInspector`		the provision query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProvisionSequencing
Description	Applies a provision search order to this distributor.
Parameters	`osid.provisioning.ProvisionSearchOrder`	`provisionSearchOrder`	the provision search order
Errors	NULL_ARGUMENT		`provisionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`provisionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionQueryFromInspector
Description	Gets a provision query from an inspector.
Parameters	`osid.provisioning.ProvisionQueryInspector`	`provisionQueryInspector`	a provision query inspector
Return	`osid.provisioning.ProvisionQuery`		the provision query
Errors	NULL_ARGUMENT		`provisionQueryInspector` is `null`
Errors	UNSUPPORTED		`provisionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.