OSID - osid.provisioning.rules.ProvisionEnablerSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.rules.ProvisionEnablerSmartDistributorSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProvisionEnablerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `ProvisionEnablers` . The provision enablers may be sequenced using the `ProvisionEnablerSearchOrder` from this session. This `Distributor` has a default query that matches any provision enabler and a default search order that specifies no sequencing. The queries may be examined using a `ProvisionEnablerQueryInspector` . The query may be modified by converting the inspector back to a `ProvisionEnablerQuery` .
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	getProvisionEnablerQuery
Description	Gets a provision enabler query.
Return	`osid.provisioning.rules.ProvisionEnablerQuery`		the provision enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionEnablerSearchOrder
Description	Gets a provision enabler search order.
Return	`osid.provisioning.rules.ProvisionEnablerSearchOrder`		the provision enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProvisionEnablerQuery
Description	Applies a provision enabler query to this distributor.
Parameters	`osid.provisioning.rules.ProvisionEnablerQuery`	`provisionEnablerQuery`	the provision enabler query
Errors	NULL_ARGUMENT		`provisionEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`provisionEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProvisionEnablerQuery
Description	Gets a provision enabler query inspector for this distributor.
Return	`osid.provisioning.rules.ProvisionEnablerQueryInspector`		the provision enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProvisionEnablerSequencing
Description	Applies a provision enabler search order to this distributor.
Parameters	`osid.provisioning.rules.ProvisionEnablerSearchOrder`	`provisionEnablerSearchOrder`	the provision enabler search order
Errors	NULL_ARGUMENT		`provisionEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`provisionEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionEnablerQueryFromInspector
Description	Gets a provision enabler query from an inspector.
Parameters	`osid.provisioning.rules.ProvisionEnablerQueryInspector`	`provisionEnablerQueryInspector`	a provision enabler query inspector
Return	`osid.provisioning.ProvisionQuery`		the provision enabler query
Errors	NULL_ARGUMENT		`provisionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`provisionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.