OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CompetencySearchSession
Implementsosid.resourcing.CompetencyQuerySession
Description

This session provides methods for searching among Competency objects. The search query is constructed using the CompetencyyQuery.

getCompetenciesByQuery() is the basic search method and returns a list of Competencies. A more advanced search may be performed with getCompetenciesBySearch(). It accepts a CompetencySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCompetenciesBySearch() returns a CompetencySearchResults that can be used to access the resulting CompetencyList or be used to perform a search within the result set through CompetencySearch.

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include competencies in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to competencies in this foundry

Competencies may have a query record indicated by their respective record types. The query record is accessed via the CompetencyQuery.

MethodgetCompetencySearch
Description

Gets a competency search.

Returnosid.resourcing.CompetencySearchthe competency search
CompliancemandatoryThis method must be implemented.
MethodgetCompetencySearchOrder
Description

Gets a competency search order. The CompetencySearchOrder is supplied to a CompetencySearch to specify the ordering of results.

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

Gets the search results matching the given search query using the given search.

Parametersosid.resourcing.CompetencyQuerycompetencyQuerythe competency query
osid.resourcing.CompetencySearchcompetencySearchthe competency search
Returnosid.resourcing.CompetencySearchResultsthe returned search results
ErrorsNULL_ARGUMENT competencyQuery or competencySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED competencyQuery or competencySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCompetencyQueryFromInspector
Description

Gets a competency query from an inspector. The inspector is available from a CompetencySearchResults.

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.