Interface ProficiencyAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ProficiencyBatchAdminSession

public interface ProficiencyAdminSession
extends OsidSession

This session creates, updates, and deletes Proficiencies . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Proficiency , a ProficiencyForm is requested using getProficiencyFormForCreate() specifying the desired relationship peers and record Types or none if no record Types are needed. The returned ProficiencyForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the ProficiencyForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProficiencyForm corresponds to an attempted transaction.

For updates, ProficiencyForms are requested to the Proficiency Id that is to be updated using getProficiencyFormForUpdate() . Similarly, the ProficiencyForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ProficiencyForm can only be used once for a successful update and cannot be reused.

The delete operations delete Proficiencies . To unmap a Proficiency from the current ObjectiveBank , the ProficiencyObjectiveBankAssignmentSession should be used. These delete operations attempt to remove the Proficiency itself thus removing it from all known ObjectiveBank catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasProficiency(Id proficiencyId, Id aliasId)	Adds an Id to a Proficiency for the purpose of creating compatibility.
boolean	canCreateProficiencies()	Tests if this user can create Proficiencies .
boolean	canCreateProficiencyWithRecordTypes(Type[] proficiencyRecordTypes)	Tests if this user can create a single Proficiency using the desired record types.
boolean	canDeleteProficiencies()	Tests if this user can delete Proficiencies .
boolean	canManageProficiencyAliases()	Tests if this user can manage Id aliases for proficiency entries.
boolean	canUpdateProficiencies()	Tests if this user can update Proficiencies .
Proficiency	createProficiency(ProficiencyForm proficiencyForm)	Creates a new Proficiency .
void	deleteProficiencies()	Deletes all proficiencies in this ObjectiveBank .
void	deleteProficiency(Id proficiencyId)	Deletes a Proficiency .
ObjectiveBank	getObjectiveBank()	Gets the ObjectiveBank associated with this session.
Id	getObjectiveBankId()	Gets the ObjectiveBank Id associated with this session.
ProficiencyForm	getProficiencyFormForCreate(Id objectiveId, Id resourceId, Type[] proficiencyRecordTypes)	Gets the proficiency form for creating new proficiencies.
ProficiencyForm	getProficiencyFormForUpdate(Id proficiencyId)	Gets the proficiency form for updating an existing proficiency.
void	updateProficiency(ProficiencyForm proficiencyForm)	Updates an existing proficiency.

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

getObjectiveBankId

Id getObjectiveBankId()

Gets the ObjectiveBank Id associated with this session.

Returns:

the ObjectiveBank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveBank

ObjectiveBank getObjectiveBank()
                        throws OperationFailedException,
PermissionDeniedException

Gets the ObjectiveBank associated with this session.

Returns:

the obective bank

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateProficiencies

boolean canCreateProficiencies()

Tests if this user can create Proficiencies . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Proficiency will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:

false if Proficiency creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateProficiencyWithRecordTypes

boolean canCreateProficiencyWithRecordTypes(Type[] proficiencyRecordTypes)

Tests if this user can create a single Proficiency using the desired record types. While LearningManager.getProficiencyRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Proficiency . Providing an empty array tests if a Proficiency can be created with no records.

Parameters:

proficiencyRecordTypes - array of proficiency record types

Returns:

true if Proficiency creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - proficiencyRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getProficiencyFormForCreate

ProficiencyForm getProficiencyFormForCreate(Id objectiveId,
 Id resourceId,
 Type[] proficiencyRecordTypes)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the proficiency form for creating new proficiencies. A new form should be requested for each create transaction.

Parameters:

objectiveId - the Id of the Objective

resourceId - the Id of the Resource

proficiencyRecordTypes - array of proficiency record types

Returns:

the proficiency form

Throws:

NotFoundException - objectiveId or resourceId is not found

NullArgumentException - objectiveId, resourceId , or proficienyRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createProficiency

Proficiency createProficiency(ProficiencyForm proficiencyForm)
                       throws OperationFailedException,
PermissionDeniedException

Creates a new Proficiency . A new form should be requested for each create transaction.

Parameters:

proficiencyForm - the form for this Proficiency

Returns:

the new Proficiency

Throws:

IllegalStateException - proficiencyForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - proficiencyForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - proficiencyForm did not originate from getProficiencyFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateProficiencies

boolean canUpdateProficiencies()

Tests if this user can update Proficiencies . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Proficiency will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:

false if Proficiency modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getProficiencyFormForUpdate

ProficiencyForm getProficiencyFormForUpdate(Id proficiencyId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the proficiency form for updating an existing proficiency.

Parameters:

proficiencyId - the Id of the Proficiency

Returns:

the proficiency form

Throws:

NotFoundException - proficiencyId is not found

NullArgumentException - proficiencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProficiency

void updateProficiency(ProficiencyForm proficiencyForm)
                throws OperationFailedException,
PermissionDeniedException

Updates an existing proficiency.

Parameters:

proficiencyForm - the form containing the elements to be updated

Throws:

IllegalStateException - proficiencyForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - proficiencyForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - proficiencyForm did not originate from getProficiencyFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteProficiencies

boolean canDeleteProficiencies()

Tests if this user can delete Proficiencies . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Proficiency will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:

false if Proficiency deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteProficiency

void deleteProficiency(Id proficiencyId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Proficiency .

Parameters:

proficiencyId - the Id of the Proficiency to remove

Throws:

NotFoundException - proficiencyId not found

NullArgumentException - proficiencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProficiencies

void deleteProficiencies()
                  throws OperationFailedException,
PermissionDeniedException

Deletes all proficiencies in this ObjectiveBank .

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageProficiencyAliases

boolean canManageProficiencyAliases()

Tests if this user can manage Id aliases for proficiency entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Proficiency aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasProficiency

void aliasProficiency(Id proficiencyId,
 Id aliasId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Proficiency for the purpose of creating compatibility. The primary Id of the Proficiency is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another proficiency, it is reassigned to the given proficiency Id .

Parameters:

proficiencyId - the Id of a Proficiency

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - proficiencyId not found

NullArgumentException - proficiencyId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.