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

Interface	osid.provisioning.rules.BrokerEnablerSmartDistributorSession
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 `BrokerEnablerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `BrokerEnablers` . The broker enablers may be sequenced using the `BrokerEnablerSearchOrder` from this session. This `Distributor` has a default query that matches any broker enabler and a default search order that specifies no sequencing. The queries may be examined using a `BrokerEnablerQueryInspector` . The query may be modified by converting the inspector back to a `BrokerEnablerQuery` .
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	getBrokerEnablerQuery
Description	Gets a broker enabler query.
Return	`osid.provisioning.rules.BrokerEnablerQuery`		the broker enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerEnablerSearchOrder
Description	Gets a broker enabler search order.
Return	`osid.provisioning.rules.BrokerEnablerSearchOrder`		the broker enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerEnablerQuery
Description	Applies a broker enabler query to this distributor.
Parameters	`osid.provisioning.rules.BrokerEnablerQuery`	`brokerEnablerQuery`	the broker enabler query
Errors	NULL_ARGUMENT		`brokerEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBrokerEnablerQuery
Description	Gets a broker enabler query inspector for this distributor.
Return	`osid.provisioning.rules.BrokerEnablerQueryInspector`		the broker enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerEnablerSequencing
Description	Applies a broker enabler search order to this distributor.
Parameters	`osid.provisioning.rules.BrokerEnablerSearchOrder`	`brokerEnablerSearchOrder`	the broker enabler search order
Errors	NULL_ARGUMENT		`brokerEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerEnablerQueryFromInspector
Description	Gets a broker enabler query from an inspector.
Parameters	`osid.provisioning.rules.BrokerEnablerQueryInspector`	`brokerEnablerQueryInspector`	a broker enabler query inspector
Return	`osid.provisioning.BrokerQuery`		the broker enabler query
Errors	NULL_ARGUMENT		`brokerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.