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

Interface	osid.resourcing.rules.JobConstrainerEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.resourcing.rules.JobConstrainerEnablerSearchSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session provides methods for searching among `JobConstrainerEnabler` objects. The search query is constructed using the `JobConstrainerEnablerQuery`. This session defines views that offer differing behaviors for searching. federated foundry view: searches include job constrainer enablers in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to job constrainer enablers in this foundry Job constrainer enablers may have a job constrainer enabler query record indicated by their respective record types. The job constrainer enabler query record is accessed via the `JobConstrainerEnablerQuery`.
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	canSearchJobConstrainerEnablers
Description	Tests if this user can perform `JobConstrainerEnabler` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include job constrainer enablers in foundries which are children of this job in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	getJobConstrainerEnablerQuery
Description	Gets a job constrainer enabler query.
Return	`osid.resourcing.rules.JobConstrainerEnablerQuery`		the job constrainer enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerEnablersByQuery
Description	Gets a list of `JobConstrainerEnablers` matching the given job constrainer enabler query.
Parameters	`osid.resourcing.rules.JobConstrainerEnablerQuery`	`jobConstrainerEnablerQuery`	the job constrainer enabler query
Return	`osid.resourcing.rules.JobConstrainerEnablerList`		the returned `JobConstrainerEnablerList`
Errors	NULL_ARGUMENT		`jobConstrainerEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobConstrainerEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.