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

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

Tests if this user can perform lookups of competency/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.
MethoduseComparativeCompetencyFoundryView
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.
MethodusePlenaryCompetencyFoundryView
Description

A complete view of the Competency 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.
MethodgetCompetencyIdsByFoundry
Description

Gets the list of Competency Ids associated with a Foundry.

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

Gets the list of competencies associated with a Foundry.

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

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

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

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

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

Gets the Foundry Ids mapped to a Competency.

Parametersosid.id.IdcompetencyId Id of a Competency
Returnosid.id.IdListlist of foundries
ErrorsNOT_FOUND competencyId is not found
NULL_ARGUMENT competencyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByCompetency
Description

Gets the Foundries mapped to a Competency.

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