OSID - osid.resourcing.JobLookupSession Service Interface Definition

Interface	osid.resourcing.JobLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Job` objects. 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 methods in this session operate, retrieve and pertain to jobs defined explicitly in the current foundry. Using an isolated view is useful for managing `Jobs` with the `JobAdminSession.` federated foundry view: All job methods in this session operate, retrieve and pertain to all jobs defined in this foundry and any other jobs implicitly available in this foundry through foundry inheritence. active job view: All job lookup methods return active jobs. any status job view: Jobs 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 any lookup methods.
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	canLookupJobs
Description	Tests if this user can perform `Job` 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	useComparativeJobView
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	usePlenaryJobView
Description	A complete view of the `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 jobs 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	useActiveJobView
Description	Only active jobs are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusJobView
Description	All active and inactive authorization enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getJob
Description	Gets the `Job` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Job` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Job` and retained for compatibility. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
Parameters	`osid.id.Id`	`jobId`	`Id` of the `Job`
Return	`osid.resourcing.Job`		the job
Errors	NOT_FOUND		`jobId` not found
	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getJobsByIds
Description	Gets a `JobList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the jobs 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 `Jobs` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
Parameters	`osid.id.IdList`	`jobIds`	the list of `Ids` to retrieve
Return	`osid.resourcing.JobList`		the returned `Job` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`jobIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobsByGenusType
Description	Gets a `JobList` corresponding to the given job genus `Type` which does not include jobs of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
Parameters	`osid.type.Type`	`jobGenusType`	a job genus type
Return	`osid.resourcing.JobList`		the returned `Job` list
Errors	NULL_ARGUMENT		`jobGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobsByParentGenusType
Description	Gets a `JobList` corresponding to the given job genus `Type` and include any additional jobs with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
Parameters	`osid.type.Type`	`jobGenusType`	a job genus type
Return	`osid.resourcing.JobList`		the returned `Job` list
Errors	NULL_ARGUMENT		`jobGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobsByRecordType
Description	Gets a `JobList` containing the given job record `Type.` In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
Parameters	`osid.type.Type`	`jobRecordType`	a job record type
Return	`osid.resourcing.JobList`		the returned `Job` list
Errors	NULL_ARGUMENT		`jobRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobsByProvider
Description	Gets a `JobList` from the given provider. In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.resourcing.JobList`		the returned `Job` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJobs
Description	Gets all `Jobs.` In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
Return	`osid.resourcing.JobList`		a list of `Jobs`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.