org.osid.learning

Interface ProficiencyObjectiveBankAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ProficiencyObjectiveBankAssignmentSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignProficiencyToObjectiveBank(Id proficiencyId, Id objectiveBankId) Adds an existing Proficiency to a ObjectiveBank.
boolean	canAssignProficiencies() Tests if this user can alter proficiency/objective bank mappings.
boolean	canAssignProficienciesToObjectiveBank(Id objectiveBankId) Tests if this user can alter proficiency/objective bank mappings.
IdList	getAssignableObjectiveBankIds(Id objectiveBankId) Gets a list of objective banks including and under the given objective bank proficiency in which any proficiency can be assigned.
IdList	getAssignableObjectiveBankIdsForProficiency(Id objectiveBankId, Id proficiencyId) Gets a list of objective banks including and under the given objective bank proficiency in which a specific proficiency can be assigned.
void	unassignProficiencyFromObjectiveBank(Id proficiencyId, Id objectiveBankId) Removes a Proficiency from a ObjectiveBank.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignProficiencies

boolean canAssignProficiencies()

Tests if this user can alter proficiency/objective bank 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.

canAssignProficienciesToObjectiveBank

boolean canAssignProficienciesToObjectiveBank(Id objectiveBankId)

Tests if this user can alter proficiency/objective bank 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:

objectiveBankId - the Id of the ObjectiveBank

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - objectiveBankId is null

Compliance:

mandatory - This method must be implemented.

getAssignableObjectiveBankIds

IdList getAssignableObjectiveBankIds(Id objectiveBankId)
                                     throws OperationFailedException

Gets a list of objective banks including and under the given objective bank proficiency in which any proficiency can be assigned.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

list of assignable objectiveBank Ids

Throws:

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableObjectiveBankIdsForProficiency

IdList getAssignableObjectiveBankIdsForProficiency(Id objectiveBankId,
                                                 Id proficiencyId)
                                                   throws OperationFailedException

Gets a list of objective banks including and under the given objective bank proficiency in which a specific proficiency can be assigned.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proficiencyId - the Id of the Proficiency

Returns:

list of assignable objectiveBank Ids

Throws:

NullArgumentException - objectiveBankId or proficiencyId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignProficiencyToObjectiveBank

void assignProficiencyToObjectiveBank(Id proficiencyId,
                                    Id objectiveBankId)
                                      throws AlreadyExistsException,
                                             NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Adds an existing Proficiency to a ObjectiveBank.

Parameters:

proficiencyId - the Id of the Proficiency

objectiveBankId - the Id of the ObjectiveBank

Throws:

AlreadyExistsException - proficiencyId is already mapped to objectiveBankId

NotFoundException - proficiencyId or objectiveBankId not found

NullArgumentException - proficiencyId or objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProficiencyFromObjectiveBank

void unassignProficiencyFromObjectiveBank(Id proficiencyId,
                                        Id objectiveBankId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Removes a Proficiency from a ObjectiveBank.

Parameters:

proficiencyId - the Id of the Proficiency

objectiveBankId - the Id of the ObjectiveBank

Throws:

NotFoundException - proficiencyId or objectiveBankId not found or proficiencyId not mapped to objectiveBankId

NullArgumentException - proficiencyId or objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.