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

Interface	osid.provisioning.rules.BrokerProcessorSmartDistributorSession
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 `BrokerProcessorQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `BrokerProcessors` . The broker processors may be sequenced using the `BrokerProcessorSearchOrder` from this session. This `Distributor` has a default query that matches any broker processor and a default search order that specifies no sequencing. The queries may be examined using a `BrokerProcessorQueryInspector` . The query may be modified by converting the inspector back to a `BrokerProcessorQuery` .
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	getBrokerProcessorQuery
Description	Gets a broker processor query.
Return	`osid.provisioning.rules.BrokerProcessorQuery`		the broker processor query
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorSearchOrder
Description	Gets a broker processor search order.
Return	`osid.provisioning.rules.BrokerProcessorSearchOrder`		the broker processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerProcessorQuery
Description	Applies a broker processor query to this distributor.
Parameters	`osid.provisioning.rules.BrokerProcessorQuery`	`brokerProcessorQuery`	the broker processor query
Errors	NULL_ARGUMENT		`brokerProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBrokerProcessorQuery
Description	Gets a broker processor query inspector for this distributor.
Return	`osid.provisioning.rules.BrokerProcessorQueryInspector`		the broker processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerProcessorSequencing
Description	Applies a broker processor search order to this distributor.
Parameters	`osid.provisioning.rules.BrokerProcessorSearchOrder`	`brokerProcessorSearchOrder`	the broker processor search order
Errors	NULL_ARGUMENT		`brokerProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorQueryFromInspector
Description	Gets a broker processor query from an inspector.
Parameters	`osid.provisioning.rules.BrokerProcessorQueryInspector`	`brokerProcessorQueryInspector`	a broker processor query inspector
Return	`osid.provisioning.rules.BrokerProcessorQuery`		the broker processor query
Errors	NULL_ARGUMENT		`brokerProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.