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

Interface	osid.resourcing.rules.JobProcessorEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session provides methods to retrieve `JobProcessorEnabler` to `JobProcessor` mappings. A `JobProcessor` with multiple `JobProcessorEnablers` means any positive rule evaluation across the enablers result in an effective `JobProcessor` . 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 processor enablers defined explicitly in the current foundry federated foundry view: All methods in this session operate, retrieve and pertain to all job processor enablers defined in this foundry and any other job processor enablers 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	canLookupJobProcessorEnablerRules
Description	Tests if this user can perform lookups of job processor enabler/job processor 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	useComparativeJobProcessorEnablerRuleView
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	usePlenaryJobProcessorEnablerRuleView
Description	A complete view of the `JobProcessorEnabler` and `JobProcessor` 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 processor enablers 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	getJobProcessorEnablerIdsForJobProcessor
Description	Gets the `JobProcessorEnabler Id` associated with a `JobProcessor` .
Parameters	`osid.id.Id`	`jobProcessorId`	`Id` of the `JobProcessor`
Return	`osid.id.IdList`		the job processor enabler `Ids`
Errors	NOT_FOUND		`jobProcessorId` is not found
	NULL_ARGUMENT		`jobProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablersForJobProcessor
Description	Gets the `JobProcessorEnabler` associated with a `JobProcessor` .
Parameters	`osid.id.Id`	`jobProcessorId`	`Id` of the `JobProcessor`
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the job processor enablers
Errors	NOT_FOUND		`jobProcessorId` is not found
	NULL_ARGUMENT		`jobProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorIdsForJobProcessorEnabler
Description	Gets the `JobProcessor` `Ids` mapped to a `JobProcessorEnabler` .
Parameters	`osid.id.Id`	`jobProcessorEnablerId`	`Id` of a `JobProcessorEnabler`
Return	`osid.id.IdList`		list of job processor `Ids`
Errors	NOT_FOUND		`jobProcessorEnablerId` is not found
	NULL_ARGUMENT		`jobProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorsForJobProcessorEnabler
Description	Gets the `JobProcessors` mapped to a `JobProcessorEnabler` .
Parameters	`osid.id.Id`	`jobProcessorEnablerId`	`Id` of a `JobProcessorEnabler`
Return	`osid.resourcing.rules.JobProcessorList`		list of job processors
Errors	NOT_FOUND		`jobProcessorEnablerId` is not found
	NULL_ARGUMENT		`jobProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.