OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.JobLookupSession
Implementsosid.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.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupJobs
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeJobView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryJobView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedFoundryView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveJobView
Description

Only active jobs are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusJobView
Description

All active and inactive authorization enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetJob
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.

Parametersosid.id.IdjobId Id of the Job
Returnosid.resourcing.Jobthe job
ErrorsNOT_FOUND jobId not found
NULL_ARGUMENT jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetJobsByIds
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.

Parametersosid.id.IdListjobIdsthe list of Ids to retrieve
Returnosid.resourcing.JobListthe returned Job list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT jobIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobsByGenusType
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.

Parametersosid.type.TypejobGenusTypea job genus type
Returnosid.resourcing.JobListthe returned Job list
ErrorsNULL_ARGUMENT jobGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobsByParentGenusType
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.

Parametersosid.type.TypejobGenusTypea job genus type
Returnosid.resourcing.JobListthe returned Job list
ErrorsNULL_ARGUMENT jobGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobsByRecordType
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.

Parametersosid.type.TypejobRecordTypea job record type
Returnosid.resourcing.JobListthe returned Job list
ErrorsNULL_ARGUMENT jobRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobsByProvider
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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.resourcing.JobListthe returned Job list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobs
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.

Returnosid.resourcing.JobLista list of Jobs
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.