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

This session provides methods for retrieving premade Competencies. The Competency represents a set of efforts .

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 competency methods in this session operate, retrieve and pertain to competencies defined explicitly in the current foundry. Using an isolated view is useful for managing Competencies with the CompetencyAdminSession.
  • federated foundry view: All competency methods in this session operate, retrieve and pertain to all competencies defined in this foundry and any other competencies implicitly available in this foundry through foundry inheritence.

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 the methods in this session.

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.
MethodcanLookupCompetencies
Description

Tests if this user can perform Competency 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.
MethoduseComparativeCompetencyView
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.
MethodusePlenaryCompetencyView
Description

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

Gets the Competency specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Competency may have a different Id than requested, such as the case where a duplicate Id was assigned to a Competency and retained for compatibility.

Parametersosid.id.IdcompetencyId Id of the Competency
Returnosid.resourcing.Competencythe competency
ErrorsNOT_FOUND competencyId not found
NULL_ARGUMENT competencyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCompetenciesByIds
Description

Gets a CompetencyList corresponding to the given IdList. In plenary mode, the returned list contains all of the competencies 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 Competencies may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListcompetencyIdsthe list of Ids to retrieve
Returnosid.resourcing.CompetencyListthe returned Competency list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT competencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompetenciesByGenusType
Description

Gets a CompetencyList corresponding to the given competency genus Type which does not include competencies of genus types derived from the specified Type. In plenary mode, the returned list contains all known competencies or an error results. Otherwise, the returned list may contain only those competencies that are accessible through this session.

Parametersosid.type.TypecompetencyGenusTypea competency genus type
Returnosid.resourcing.CompetencyListthe returned Competency list
ErrorsNULL_ARGUMENT competencyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompetenciesByParentGenusType
Description

Gets a CompetencyList corresponding to the given competency genus Type and include any additional competencies with genus types derived from the specified Type. In plenary mode, the returned list contains all known competencies or an error results. Otherwise, the returned list may contain only those competencies that are accessible through this session.

Parametersosid.type.TypecompetencyGenusTypea competency genus type
Returnosid.resourcing.CompetencyListthe returned Competency list
ErrorsNULL_ARGUMENT competencyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompetenciesByRecordType
Description

Gets a CompetencyList containing the given competency record Type. In plenary mode, the returned list contains all known competencies or an error results. Otherwise, the returned list may contain only those competencies that are accessible through this session.

Parametersosid.type.TypecompetencyRecordTypea competency record type
Returnosid.resourcing.CompetencyListthe returned Competency list
ErrorsNULL_ARGUMENT competencyRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompetencies
Description

Gets all Competencies. In plenary mode, the returned list contains all known competencies or an error results. Otherwise, the returned list may contain only those competencies that are accessible through this session.

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