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

Interface	osid.provisioning.rules.BrokerConstrainerSmartDistributorSession
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 `BrokerConstrainerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `BrokerConstrainers`. The broker constrainers may be sequenced using the `BrokerConstrainerSearchOrder` from this session. This `Distributor` has a default query that matches any broker constrainer and a default search order that specifies no sequencing. The queries may be examined using a `BrokerConstrainerQueryInspector`. The query may be modified by converting the inspector back to a `BrokerConstrainerQuery`.
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	getBrokerConstrainerQuery
Description	Gets a broker constrainer query.
Return	`osid.provisioning.rules.BrokerConstrainerQuery`		the broker constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerSearchOrder
Description	Gets a broker constrainer search order.
Return	`osid.provisioning.rules.BrokerConstrainerSearchOrder`		the broker constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerConstrainerQuery
Description	Applies a broker constrainer query to this distributor.
Parameters	`osid.provisioning.rules.BrokerConstrainerQuery`	`brokerConstrainerQuery`	the broker constrainer query
Errors	NULL_ARGUMENT		`brokerConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBrokerConstrainerQuery
Description	Gets a broker constrainer query inspector for this distributor.
Return	`osid.provisioning.rules.BrokerConstrainerQueryInspector`		the broker constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerConstrainerSequencing
Description	Applies a broker constrainer search order to this distributor.
Parameters	`osid.provisioning.rules.BrokerConstrainerSearchOrder`	`brokerConstrainerSearchOrder`	the broker constrainer search order
Errors	NULL_ARGUMENT		`brokerConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerQueryFromInspector
Description	Gets a broker constrainer query from an inspector.
Parameters	`osid.provisioning.rules.BrokerConstrainerQueryInspector`	`brokerConstrainerQueryInspector`	a broker constrainer query inspector
Return	`osid.provisioning.rules.BrokerConstrainerQuery`		the broker constrainer query
Errors	NULL_ARGUMENT		`brokerConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.