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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CompetencyQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of competencies. The competencies may be sequenced using the CompetencySearchOrder from this session.

This Foundry has a default query that matches any competency and a default search order that specifies no sequencing. The queries may be examined using a CompetencyQueryInspector. The query may be modified by converting the inspector back to a CompetencyQuery.

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

Tests if this user can manage smart foundries. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart foundry management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCompetencyQuery
Description

Gets a competency query.

Returnosid.resourcing.CompetencyQuerythe competency query
CompliancemandatoryThis method must be implemented.
MethodgetCompetencySearchOrder
Description

Gets a competency search order.

Returnosid.resourcing.CompetencySearchOrderthe competency search order
CompliancemandatoryThis method must be implemented.
MethodapplyCompetencyQuery
Description

Applies a competency query to this foundry.

Parametersosid.resourcing.CompetencyQuerycompetencyQuerythe competency query
ErrorsNULL_ARGUMENT competencyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED competencyQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecCompetencyQuery
Description

Gets a competency query inspector for this foundry.

Returnosid.resourcing.CompetencyQueryInspectorthe competency query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCompetencySequencing
Description

Applies a competency search order to this foundry.

Parametersosid.resourcing.CompetencySearchOrdercompetencySearchOrderthe competency search order
ErrorsNULL_ARGUMENT competencySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED competencySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCompetencyQueryFromInspector
Description

Gets a competency query from an inspector.

Parametersosid.resourcing.CompetencyQueryInspectorcompetencyQueryInspectora competency query inspector
Returnosid.resourcing.CompetencyQuerythe competency query
ErrorsNULL_ARGUMENT competencyQueryInspector is null
UNSUPPORTED competencyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.