Interface CompetencySearchSession

All Superinterfaces:

AutoCloseable, Closeable, CompetencyQuerySession, OsidSession, OsidSession

public interface CompetencySearchSession
extends CompetencyQuerySession

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 .

Method Summary

Modifier and Type	Method	Description
CompetencySearchResults	getCompetenciesBySearch(CompetencyQuery competencyQuery, CompetencySearch competencySearch)	Gets the search results matching the given search query using the given search.
CompetencyQuery	getCompetencyQueryFromInspector(CompetencyQueryInspector competencyQueryInspector)	Gets a competency query from an inspector.
CompetencySearch	getCompetencySearch()	Gets a competency search.
CompetencySearchOrder	getCompetencySearchOrder()	Gets a competency search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CompetencyQuerySession

canSearchCompetencies, getCompetenciesByQuery, getCompetencyQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView

Modifier and Type	Method	Description
boolean	canSearchCompetencies()	Tests if this user can perform Competency lookups.
CompetencyList	getCompetenciesByQuery(CompetencyQuery competencyQuery)	Gets a list of Competencies matching the given competency query.
CompetencyQuery	getCompetencyQuery()	Gets a competency query.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	useFederatedFoundryView()	Federates the view for methods in this session.
void	useIsolatedFoundryView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCompetencySearch

CompetencySearch getCompetencySearch()

Gets a competency search.

Returns:

the competency search

Compliance:

mandatory - This method must be implemented.

getCompetencySearchOrder

CompetencySearchOrder getCompetencySearchOrder()

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

Returns:

the competency search order

Compliance:

mandatory - This method must be implemented.

getCompetenciesBySearch

CompetencySearchResults getCompetenciesBySearch(CompetencyQuery competencyQuery,
 CompetencySearch competencySearch)
                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

competencyQuery - the competency query

competencySearch - the competency search

Returns:

the returned search results

Throws:

NullArgumentException - competencyQuery or competencySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - competencyQuery or competencySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCompetencyQueryFromInspector

CompetencyQuery getCompetencyQueryFromInspector(CompetencyQueryInspector competencyQueryInspector)

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

Parameters:

competencyQueryInspector - a competency query inspector

Returns:

the competency query

Throws:

NullArgumentException - competencyQueryInspector is null

UnsupportedException - competencyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.