Interface CompetencyFoundryAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CompetencyFoundryAssignmentSession
extends OsidSession

This session provides methods to re-assign Competency to Foundry mappings. A Competency may appear in multiple Foundry objects and removing the last reference to a Competency is the equivalent of deleting it. Each Foundry may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Competency to another Foundry is not a copy operation (eg: does not change its Id ).

Method Summary

Modifier and Type	Method	Description
void	assignCompetencyToFoundry(Id competencyId, Id foundryId)	Adds an existing Competency to a Foundry .
boolean	canAssignCompetencies()	Tests if this user can alter competency/foundry mappings.
boolean	canAssignCompetenciesToFoundry(Id foundryId)	Tests if this user can alter competency/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId)	Gets a list of foundries including and under the given foundry node in which any competency can be assigned.
IdList	getAssignableFoundryIdsForCompetency(Id foundryId, Id competencyId)	Gets a list of foundries including and under the given foundry node in which a specific competency can be assigned.
void	reassignCompetencyToFoundry(Id competencyId, Id fromFoundryId, Id toFoundryId)	Moves a Competency from one Foundry to another.
void	unassignCompetencyFromFoundry(Id competencyId, Id foundryId)	Removes a Competency from a Foundry .

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

canAssignCompetencies

boolean canAssignCompetencies()

Tests if this user can alter competency/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignCompetenciesToFoundry

boolean canAssignCompetenciesToFoundry(Id foundryId)

Tests if this user can alter competency/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parameters:

foundryId - the Id of the Foundry

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

getAssignableFoundryIds

IdList getAssignableFoundryIds(Id foundryId)
                        throws OperationFailedException

Gets a list of foundries including and under the given foundry node in which any competency can be assigned.

Parameters:

foundryId - the Id of the Foundry

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableFoundryIdsForCompetency

IdList getAssignableFoundryIdsForCompetency(Id foundryId,
 Id competencyId)
                                     throws OperationFailedException

Gets a list of foundries including and under the given foundry node in which a specific competency can be assigned.

Parameters:

foundryId - the Id of the Foundry

competencyId - the Id of the Competency

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or competencyId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignCompetencyToFoundry

void assignCompetencyToFoundry(Id competencyId,
 Id foundryId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Competency to a Foundry .

Parameters:

competencyId - the Id of the Competency

foundryId - the Id of the Foundry

Throws:

NotFoundException - competencyId or foundryId not found

NullArgumentException - competencyId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCompetencyFromFoundry

void unassignCompetencyFromFoundry(Id competencyId,
 Id foundryId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a Competency from a Foundry .

Parameters:

competencyId - the Id of the Competency

foundryId - the Id of the Foundry

Throws:

NotFoundException - competencyId or foundryId not found

NullArgumentException - competencyId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignCompetencyToFoundry

void reassignCompetencyToFoundry(Id competencyId,
 Id fromFoundryId,
 Id toFoundryId)
                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves a Competency from one Foundry to another. Mappings to other Foundries are unaffected.

Parameters:

competencyId - the Id of the Competency

fromFoundryId - the Id of the current Foundry

toFoundryId - the Id of the destination Foundry

Throws:

AlreadyExistsException - competencyId already assigned to toFoundryId

NotFoundException - competencyId, fromFoundryId , or toFoundryId not found or competencyId not mapped to fromFoundryId

NullArgumentException - competencyId, fromFoundryId , or toFoundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.