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

Interface	osid.resourcing.rules.JobProcessorSmartFoundrySession
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 `JobProcessorQuery` can be retrieved from this session and mapped to this `Foundry` to create a virtual collection of job processors. The job processor may be sequenced using the `JobProcessorSearchOrder` from this session. This `Foundry` has a default query that matches any job processor and a default search order that specifies no sequencing. The queries may be examined using a `JobProcessorQueryInspector`. The query may be modified by converting the inspector back to a `JobProcessorQuery`.
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	getJobProcessorQuery
Description	Gets a job processor query.
Return	`osid.resourcing.rules.JobProcessorQuery`		the job processor query
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorSearchOrder
Description	Gets a job processor search order.
Return	`osid.resourcing.rules.JobProcessorSearchOrder`		the job processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyJobProcessorQuery
Description	Applies a job processor query to this foundry.
Parameters	`osid.resourcing.rules.JobProcessorQuery`	`jobProcessorQuery`	the job processor query
Errors	NULL_ARGUMENT		`jobProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`jobProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectJobProcessorQuery
Description	Gets a job processor query inspector for this foundry.
Return	`osid.resourcing.rules.JobProcessorQueryInspector`		the job processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyJobProcessorSequencing
Description	Applies a job processor search order to this foundry.
Parameters	`osid.resourcing.rules.JobProcessorSearchOrder`	`jobProcessorSearchOrder`	the job processor search order
Errors	NULL_ARGUMENT		`jobProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`jobProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorQueryFromInspector
Description	Gets a job processor query from an inspector.
Parameters	`osid.resourcing.rules.JobProcessorQueryInspector`	`jobProcessorQueryInspector`	a job processor query inspector
Return	`osid.resourcing.rules.JobProcessorQuery`		the job processor query
Errors	NULL_ARGUMENT		`jobProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`jobProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.