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

Interface	osid.resourcing.rules.JobConstrainerSmartFoundrySession
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 `JobConstrainerQuery` can be retrieved from this session and mapped to this `Foundry` to create a virtual collection of job constrainers. The job constrainer may be sequenced using the `JobConstrainerSearchOrder` from this session. This `Foundry` has a default query that matches any job constrainer and a default search order that specifies no sequencing. The queries may be examined using a `JobConstrainerQueryInspector`. The query may be modified by converting the inspector back to a `JobConstrainerQuery`.
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	getJobConstrainerQuery
Description	Gets a job constrainer query.
Return	`osid.resourcing.rules.JobConstrainerQuery`		the job constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerSearchOrder
Description	Gets a job constrainer search order.
Return	`osid.resourcing.rules.JobConstrainerSearchOrder`		the job constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyJobConstrainerQuery
Description	Applies a job constrainer query to this foundry.
Parameters	`osid.resourcing.rules.JobConstrainerQuery`	`jobConstrainerQuery`	the job constrainer query
Errors	NULL_ARGUMENT		`jobConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`jobConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectJobConstrainerQuery
Description	Gets a job constrainer query inspector for this foundry.
Return	`osid.resourcing.rules.JobConstrainerQueryInspector`		the job constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyJobConstrainerSequencing
Description	Applies a job constrainer search order to this foundry.
Parameters	`osid.resourcing.rules.JobConstrainerSearchOrder`	`jobConstrainerSearchOrder`	the job constrainer search order
Errors	NULL_ARGUMENT		`jobConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`jobConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerQueryFromInspector
Description	Gets a job constrainer query from an inspector.
Parameters	`osid.resourcing.rules.JobConstrainerQueryInspector`	`jobConstrainerQueryInspector`	a job constrainer query inspector
Return	`osid.resourcing.rules.JobConstrainerQuery`		the job constrainer query
Errors	NULL_ARGUMENT		`jobConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`jobConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.