OSID - osid.resourcing.JobSmartFoundrySession Service Interface Definition

Interface	osid.resourcing.JobSmartFoundrySession
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 `JobQuery` can be retrieved from this session and mapped to this `Foundry` to create a virtual collection of `Jobs`. The jobs may be sequenced using the `JobSearchOrder` from this session. This `Foundry` has a default query that matches any job and a default search order that specifies no sequencing. The queries may be examined using a `JobQueryInspector`. The query may be modified by converting the inspector back to a `JobQuery`.
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	getJobQuery
Description	Gets a job query.
Return	`osid.resourcing.JobQuery`		the job query
Compliance	`mandatory`		This method must be implemented.
Method	getJobSearchOrder
Description	Gets a job search order.
Return	`osid.resourcing.JobSearchOrder`		the job search order
Compliance	`mandatory`		This method must be implemented.
Method	applyJobQuery
Description	Applies a job query to this foundry.
Parameters	`osid.resourcing.JobQuery`	`jobQuery`	the job query
Errors	NULL_ARGUMENT		`jobQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`jobQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectJobQuery
Description	Gets a job query inspector for this foundry.
Return	`osid.resourcing.JobQueryInspector`		the job query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyJobSequencing
Description	Applies a job search order to this foundry.
Parameters	`osid.resourcing.JobSearchOrder`	`jobSearchOrder`	the job search order
Errors	NULL_ARGUMENT		`jobSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`jobSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJobQueryFromInspector
Description	Gets a job query from an inspector.
Parameters	`osid.resourcing.JobQueryInspector`	`jobQueryInspector`	a job query inspector
Return	`osid.resourcing.JobQuery`		the job query
Errors	NULL_ARGUMENT		`jobQueryInspector` is `null`
Errors	UNSUPPORTED		`jobQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.