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

Interface	osid.resourcing.rules.JobConstrainerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `JobConstrainer` to `Job` mappings. A `Job` with multiple `JobConstrainers` means any positive rule evaluation across the result in an effective `Job.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated foundry view: All methods in this session operate, retrieve and pertain job constrainer defined explicitly in the current foundry federated foundry view: All methods in this session operate, retrieve and pertain to all job constrainer defined in this foundry and any other job constrainer implicitly available in this foundry through foundry inheritence.
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	canLookupJobConstrainerRules
Description	Tests if this user can perform lookups of job constrainer/job mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeJobConstrainerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryJobConstrainerRuleView
Description	A complete view of the `JobConstrainer` and `Job` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include job constrainer in foundries which are children of this foundry 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	getJobConstrainerIdsForJob
Description	Gets the `JobConstrainer Id` associated with a `Job.`
Parameters	`osid.id.Id`	`jobId`	`Id` of the `Job`
Return	`osid.id.IdList`		the job constrainer `Ids`
Errors	NOT_FOUND		`jobId` is not found
	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainersForJob
Description	Gets the `JobConstrainer` associated with a `Job.`
Parameters	`osid.id.Id`	`jobId`	`Id` of the `Job`
Return	`osid.resourcing.rules.JobConstrainerList`		the job constrainers
Errors	NOT_FOUND		`jobId` is not found
	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobIdsForJobConstrainer
Description	Gets the `Job` `Ids` mapped to a `JobConstrainer.`
Parameters	`osid.id.Id`	`jobConstrainerId`	`Id` of a `JobConstrainer`
Return	`osid.id.IdList`		list of job `Ids`
Errors	NOT_FOUND		`jobConstrainerId` is not found
	NULL_ARGUMENT		`jobConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobsForJobConstrainer
Description	Gets the `Jobs` mapped to a `JobConstrainer.`
Parameters	`osid.id.Id`	`jobConstrainerId`	`Id` of a `JobConstrainer`
Return	`osid.resourcing.JobList`		list of jobs
Errors	NOT_FOUND		`jobConstrainerId` is not found
	NULL_ARGUMENT		`jobConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.