OSID - osid.provisioning.ProvisionableSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.ProvisionableSmartDistributorSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProvisionableQuery` can be retrieved from this session and distributorped to this `Distributor` to create a virtual collection of `Provisionables` . The provisionables may be sequenced using the `ProvisionableSearchOrder` from this session. This `Distributor` has a default query that matches any provisionable and a default search order that specifies no sequencing. The queries may be examined using a `ProvisionableQueryInspector` . The query may be modified by converting the inspector back to a `ProvisionableQuery` .
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	getProvisionableQuery
Description	Gets a provisionable query.
Return	`osid.provisioning.ProvisionableQuery`		the provisionable query
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableSearchOrder
Description	Gets a provisionable search order.
Return	`osid.provisioning.ProvisionableSearchOrder`		the provisionable search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProvisionableQuery
Description	Applies a provisionable query to this distributor.
Parameters	`osid.provisioning.ProvisionableQuery`	`provisionableQuery`	the provisionable query
Errors	NULL_ARGUMENT		`provisionableQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`provisionableQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProvisionableQuery
Description	Gets a provisionable query inspector for this distributor.
Return	`osid.provisioning.ProvisionableQueryInspector`		the provisionable query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProvisionableSequencing
Description	Applies a provisionable search order to this distributor.
Parameters	`osid.provisioning.ProvisionableSearchOrder`	`provisionableSearchOrder`	the provisionable search order
Errors	NULL_ARGUMENT		`provisionableSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`provisionableSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableQueryFromInspector
Description	Gets a provisionable query from an inspector.
Parameters	`osid.provisioning.ProvisionableQueryInspector`	`provisionableQueryInspector`	a provisionable query inspector
Return	`osid.provisioning.ProvisionableQuery`		the provisionable query
Errors	NULL_ARGUMENT		`provisionableQueryInspector` is `null`
Errors	UNSUPPORTED		`provisionableQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.