OSID - osid.provisioning.RequestTransactionSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.RequestTransactionSmartDistributorSession
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 `RequestTransactionQuery` can be retrieved from this session and applied to this `Distributor` to create a virtual collection of `RequestTransactions` . The request transactions may be sequenced using the `RequestTransactionSearchOrder` from this session. This `Distributor` has a default query that matches any request transaction and a default search order that specifies no sequencing. The queries may be examined using a `RequestTransactionQueryInspector` . The query may be modified by converting the inspector back to a `RequestTransactionQuery` .
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	getRequestTransactionQuery
Description	Gets a request transaction query.
Return	`osid.provisioning.RequestTransactionQuery`		the request transaction query
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionSearchOrder
Description	Gets a request transaction search order.
Return	`osid.provisioning.RequestTransactionSearchOrder`		the request transaction search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRequestTransactionQuery
Description	Applies a request transaction query to this distributor.
Parameters	`osid.provisioning.RequestTransactionQuery`	`requestTransactionQuery`	the request transaction query
Errors	NULL_ARGUMENT		`requestTransactionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`requestTransactionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRequestTransactionQuery
Description	Gets a request transaction query inspector for this distributor.
Return	`osid.provisioning.RequestTransactionQueryInspector`		the request transaction query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRequestTransactionSequencing
Description	Applies a request transaction search order to this distributor.
Parameters	`osid.provisioning.RequestTransactionSearchOrder`	`requestTransactionSearchOrder`	the request transaction search order
Errors	NULL_ARGUMENT		`requestTransactionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`requestTransactionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionQueryFromInspector
Description	Gets a request transaction query from an inspector.
Parameters	`osid.provisioning.RequestTransactionQueryInspector`	`requestTransactionQueryInspector`	a request transaction query inspector
Return	`osid.provisioning.RequestTransactionQuery`		the request transaction query
Errors	NULL_ARGUMENT		`requestTransactionQueryInspector` is `null`
Errors	UNSUPPORTED		`requestTransactionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.