Interface CompetencyFoundrySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CompetencyFoundrySession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupCompetencyFoundryMappings()	Tests if this user can perform lookups of competency/foundry mappings.
CompetencyList	getCompetenciesByFoundries(IdList foundryIds)	Gets the list of competencies corresponding to a list of Foundries .
CompetencyList	getCompetenciesByFoundry(Id foundryId)	Gets the list of competencies associated with a Foundry .
IdList	getCompetencyIdsByFoundries(IdList foundryIds)	Gets the list of Competency Ids corresponding to a list of Foundries .
IdList	getCompetencyIdsByFoundry(Id foundryId)	Gets the list of Competency Ids associated with a Foundry .
FoundryList	getFoundriesByCompetency(Id competencyId)	Gets the Foundries mapped to a Competency .
IdList	getFoundryIdsByCompetency(Id competencyId)	Gets the Foundry Ids mapped to a Competency .
void	useComparativeCompetencyFoundryView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCompetencyFoundryView()	A complete view of the Competency and Foundry returns is desired.

Methods inherited from interface Closeable

close

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

canLookupCompetencyFoundryMappings

boolean canLookupCompetencyFoundryMappings()

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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCompetencyFoundryView

void useComparativeCompetencyFoundryView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCompetencyFoundryView

void usePlenaryCompetencyFoundryView()

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.

Compliance:

mandatory - This method is must be implemented.

getCompetencyIdsByFoundry

IdList getCompetencyIdsByFoundry(Id foundryId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Competency Ids associated with a Foundry .

Parameters:

foundryId - Id of the Foundry

Returns:

list of related competency Ids

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCompetenciesByFoundry

CompetencyList getCompetenciesByFoundry(Id foundryId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of competencies associated with a Foundry .

Parameters:

foundryId - Id of the Foundry

Returns:

list of related competencies

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCompetencyIdsByFoundries

IdList getCompetencyIdsByFoundries(IdList foundryIds)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

foundryIds - list of foundry Ids

Returns:

list of competency Ids

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCompetenciesByFoundries

CompetencyList getCompetenciesByFoundries(IdList foundryIds)
                                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

foundryIds - list of foundry Ids

Returns:

list of competencies

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundryIdsByCompetency

IdList getFoundryIdsByCompetency(Id competencyId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Foundry Ids mapped to a Competency .

Parameters:

competencyId - Id of a Competency

Returns:

list of foundries

Throws:

NotFoundException - competencyId is not found

NullArgumentException - competencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundriesByCompetency

FoundryList getFoundriesByCompetency(Id competencyId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Foundries mapped to a Competency .

Parameters:

competencyId - Id of a Competency

Returns:

list of foundries

Throws:

NotFoundException - competencyId is not found

NullArgumentException - competencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.