OSID - osid.provisioning.BrokerSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.BrokerSmartDistributorSession
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 `BrokerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `Brokers` . The brokers may be sequenced using the `BrokerSearchOrder` from this session. This `Distributor` has a default query that matches any broker and a default search order that specifies no sequencing. The queries may be examined using a `BrokerQueryInspector` . The query may be modified by converting the inspector back to a `BrokerQuery` .
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	getBrokerQuery
Description	Gets a broker query.
Return	`osid.provisioning.BrokerQuery`		the broker query
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerSearchOrder
Description	Gets a broker search order.
Return	`osid.provisioning.BrokerSearchOrder`		the broker search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerQuery
Description	Applies a broker query to this distributor.
Parameters	`osid.provisioning.BrokerQuery`	`brokerQuery`	the broker query
Errors	NULL_ARGUMENT		`brokerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBrokerQuery
Description	Gets a broker query inspector for this distributor.
Return	`osid.provisioning.BrokerQueryInspector`		the broker query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBrokerSequencing
Description	Applies a broker search order to this distributor.
Parameters	`osid.provisioning.BrokerSearchOrder`	`brokerSearchOrder`	the broker search order
Errors	NULL_ARGUMENT		`brokerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`brokerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerQueryFromInspector
Description	Gets a broker query from an inspector.
Parameters	`osid.provisioning.BrokerQueryInspector`	`brokerQueryInspector`	a broker query inspector
Return	`osid.provisioning.BrokerQuery`		the broker query
Errors	NULL_ARGUMENT		`brokerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.