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

This session provides methods to retrieve JobConstrainer to Foundry mappings. A JobConstrainer 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
MethodcanLookupJobConstrainerFoundryMappings
Description

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

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

A complete view of the JobConstrainer 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.
MethodgetJobConstrainerIdsByFoundry
Description

Gets the list of JobConstrainerIds associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.id.IdListlist of related job constrainer 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.
MethodgetJobConstrainersByFoundry
Description

Gets the list of job constrainer associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.resourcing.rules.JobConstrainerListlist of related job constrainers
ErrorsNOT_FOUND foundryId is not found
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerIdsByFoundries
Description

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

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

Gets the list of job constrainer corresponding to a list of Foundries.

Parametersosid.id.IdListfoundryIdslist of foundry Ids
Returnosid.resourcing.rules.JobConstrainerListlist of job constrainers
ErrorsNULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundryIdsByJobConstrainer
Description

Gets the Foundry Ids mapped to a JobConstrainer.

Parametersosid.id.IdjobConstrainerId Id of a JobConstrainer
Returnosid.id.IdListlist of foundries
ErrorsNOT_FOUND jobConstrainerId is not found
NULL_ARGUMENT jobConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundrysByJobConstrainer
Description

Gets the Foundries mapped to a JobConstrainer.

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