OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.JobFoundrySession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Job to Foundry resourcings. A Job may appear in multiple Foundry objects. Each foundry may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupJobFoundryMappings
Description

Tests if this user can perform lookups of job/foundry resourcings. 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeJobFoundryView
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.
MethodusePlenaryJobFoundryView
Description

A complete view of the Job and Foundry 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.
MethodgetJobIdsByFoundry
Description

Gets the list of Job Ids associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.id.IdListlist of related job Ids
ErrorsNOT_FOUND foundryId is not found
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobsByFoundry
Description

Gets the list of Jobs associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.resourcing.JobListlist of related jobs
ErrorsNOT_FOUND foundryId is not found
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobIdsByFoundries
Description

Gets the list of Job Ids corresponding to a list of Foundries.

Parametersosid.id.IdListfoundryIdslist of foundry Ids
Returnosid.id.IdListlist of job Ids
ErrorsNULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobsByFoundries
Description

Gets the list of Job corresponding to a list of Foundries.

Parametersosid.id.IdListfoundryIdslist of foundry Ids
Returnosid.resourcing.JobListlist of jobs
ErrorsNULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundryIdsByJob
Description

Gets the Foundry Ids mapped to a Job.

Parametersosid.id.IdjobId Id of a Job
Returnosid.id.IdListlist of foundries
ErrorsNOT_FOUND jobId is not found
NULL_ARGUMENT jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByJob
Description

Gets the Foundries mapped to a Job.

Parametersosid.id.IdjobId Id of a Job
Returnosid.resourcing.FoundryListlist of foundries
ErrorsNOT_FOUND jobId is not found
NULL_ARGUMENT jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.