OSID - osid.resourcing.rules.CommissionEnablerSmartFoundrySession Service Interface Definition

Interface	osid.resourcing.rules.CommissionEnablerSmartFoundrySession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic foundries. A `CommissionEnablerQuery` can be retrieved from this session and mapped to this `Foundry` to create a virtual collection of commission enablers. The commission enabler may be sequenced using the `CommissionEnablerSearchOrder` terface from this session. This `Foundry` has a default query that matches any commission enabler and a default search order that specifies no sequencing. The queries may be examined using a `CommissionEnablerQueryInspector` . The query may be modified by converting the inspector back to a `CommissionEnablerQuery` .
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartFoundries
Description	Tests if this user can manage smart foundries. 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 foundry management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerQuery
Description	Gets a commission enabler query.
Return	`osid.resourcing.rules.CommissionEnablerQuery`		the commission enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerSearchOrder
Description	Gets a commission enabler search order.
Return	`osid.resourcing.rules.CommissionEnablerSearchOrder`		the commission enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCommissionEnablerQuery
Description	Applies a commission enabler query to this foundry.
Parameters	`osid.resourcing.rules.CommissionEnablerQuery`	`commissionEnablerQuery`	the commission enabler query
Errors	NULL_ARGUMENT		`ccommissionEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commissionEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCommissionEnablerQuery
Description	Gets a commission enabler query inspector for this foundry.
Return	`osid.resourcing.rules.CommissionEnablerQueryInspector`		the commission enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCommissionEnablerSequencing
Description	Applies a commission enabler search order to this foundry.
Parameters	`osid.resourcing.rules.CommissionEnablerSearchOrder`	`commissionEnablerSearchOrder`	the commission enabler search order
Errors	NULL_ARGUMENT		`commissionEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commissionEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerQueryFromInspector
Description	Gets a commission enabler query from an inspector.
Parameters	`osid.resourcing.rules.CommissionEnablerQueryInspector`	`commissionEnablerQueryInspector`	a commission enabler query inspector
Return	`osid.resourcing.rules.CommissionEnablerQuery`		the commission enabler query
Errors	NULL_ARGUMENT		`commissionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`commissionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.