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

Interface	osid.resourcing.rules.JobProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `JobProcessorEnablers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated foundry view: All job processor enabler methods in this session operate, retrieve and pertain to job processor enablers defined explicitly in the current foundry. Using an isolated view is useful for managing `JobProcessorEnablers` with the `JobProcessorEnablerAdminSession.` federated foundry view: All job processor enabler 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. active job processor enabler view: All job processor enabler lookup methods return active job processor enablers. any status job processor enabler view: Job processor enablers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedFoundryView()` and `useIsolatedFoundryView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupJobProcessorEnablers
Description	Tests if this user can perform `JobProcessorEnablers` 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 opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeJobProcessorEnablerView
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	usePlenaryJobProcessorEnablerView
Description	A complete view of the `JobProcessorEnabler` 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	useActiveJobProcessorEnablerView
Description	Only active job processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusJobProcessorEnablerView
Description	All active and inactive job processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getJobProcessorEnabler
Description	Gets the `JobProcessorEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `JobProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `JobProcessorEnabler` and retained for compatibility. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Parameters	`osid.id.Id`	`jobProcessorEnablerId`	`Id` of the `JobProcessorEnabler`
Return	`osid.resourcing.rules.JobProcessorEnabler`		the job processor enabler
Errors	NOT_FOUND		`jobProcessorEnablerId` not found
	NULL_ARGUMENT		`jobProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getJobProcessorEnablersByIds
Description	Gets a `JobProcessorEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the job processor enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `JobProcessorEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Parameters	`osid.id.IdList`	`jobProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the returned `JobProcessorEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`jobProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablersByGenusType
Description	Gets a `JobProcessorEnablerList` corresponding to the given job processor enabler genus `Type` which does not include job processor enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known job processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Parameters	`osid.type.Type`	`jobProcessorEnablerGenusType`	a job processor enabler genus type
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the returned `JobProcessorEnabler` list
Errors	NULL_ARGUMENT		`jobProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablersByParentGenusType
Description	Gets a `JobProcessorEnablerList` corresponding to the given job processor enabler genus `Type` and include any additional job processor enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known job processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Parameters	`osid.type.Type`	`jobProcessorEnablerGenusType`	a job processor enabler genus type
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the returned `JobProcessorEnabler` list
Errors	NULL_ARGUMENT		`jobProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablersByRecordType
Description	Gets a `JobProcessorEnablerList` containing the given job processor enabler record `Type.` In plenary mode, the returned list contains all known job processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Parameters	`osid.type.Type`	`jobProcessorEnablerRecordType`	a job processor enabler record type
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the returned `JobProcessorEnabler` list
Errors	NULL_ARGUMENT		`jobProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablersOnDate
Description	Gets a `JobProcessorEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known job processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the returned `JobProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablersOnDateWithAgent
Description	Gets a `JobProcessorEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known job processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the returned `JobProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablers
Description	Gets all `JobProcessorEnablers.` In plenary mode, the returned list contains all known job processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.
Return	`osid.resourcing.rules.JobProcessorEnablerList`		the returned `JobProcessorEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.