OSID - osid.resourcing.CommissionSmartFoundrySession Service Interface Definition

Interface	osid.resourcing.CommissionSmartFoundrySession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CommissionQuery` can be retrieved from this session and foundryped to this `Foundry` to create a virtual collection of `Commissions` . The commissions may be sequenced using the `CommissionSearchOrder` from this session. This `Foundry` has a default query that matches any commission and a default search order that specifies no sequencing. The queries may be examined using a `CommissionQueryInspector` . The query may be modified by converting the inspector back to a `CommissionQuery` .
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	getCommissionQuery
Description	Gets a commission query.
Return	`osid.resourcing.CommissionQuery`		the commission query
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionSearchOrder
Description	Gets a commission search order.
Return	`osid.resourcing.CommissionSearchOrder`		the commission search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCommissionQuery
Description	Applies a commission query to this foundry.
Parameters	`osid.resourcing.CommissionQuery`	`commissionQuery`	the commission query
Errors	NULL_ARGUMENT		`commissionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commissionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCommissionQuery
Description	Gets a commission query inspector for this foundry.
Return	`osid.resourcing.CommissionQueryInspector`		the commission query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCommissionSequencing
Description	Applies a commission search order to this foundry.
Parameters	`osid.resourcing.CommissionSearchOrder`	`commissionSearchOrder`	the commission search order
Errors	NULL_ARGUMENT		`commissionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commissionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionQueryFromInspector
Description	Gets a commission query from an inspector.
Parameters	`osid.resourcing.CommissionQueryInspector`	`commissionQueryInspector`	a commission query inspector
Return	`osid.resourcing.CommissionQuery`		the commission query
Errors	NULL_ARGUMENT		`commissionQueryInspector` is `null`
Errors	UNSUPPORTED		`commissionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.