public interface ObjectiveObjectiveBankAssignmentSession extends OsidSession
This session provides methods to re-assign Objectives
to
ObjectiveBanks.
An Objective
may map to
multiple ObjectiveBanks
and removing the last reference to
an Objective
is the equivalent of deleting it. Each
ObjectiveBank
may have its own authorizations governing who is
allowed to operate on it.
Moving or adding a reference of an Objective
to another
ObjectiveBank
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignObjectiveToObjectiveBank(Id objectiveId,
Id objectiveBankId)
Adds an existing
Objective to an ObjectiveBank. |
boolean |
canAssignObjectives()
Tests if this user can alter objective/objective bank mappings.
|
boolean |
canAssignObjectivesToObjectiveBank(Id objectiveBankId)
Tests if this user can alter objective/objective bank mappings.
|
IdList |
getAssignableObjectiveBankIds(Id objectiveBankId)
Gets a list of objective banks including and under the given objective
bank node in which any objective can be assigned.
|
IdList |
getAssignableObjectiveBankIdsForObjective(Id objectiveBankId,
Id objectiveId)
Gets a list of objective banks including and under the given objective
bank node in which a specific objective can be assigned.
|
void |
reassignProficiencyToObjectiveBank(Id objectiveId,
Id fromObjectiveBankId,
Id toObjectiveBankId)
Moves an
Objective from one ObjectiveBank
to another. |
void |
unassignObjectiveFromObjectiveBank(Id objectiveId,
Id objectiveBankId)
Removes an
Objective from an ObjectiveBank. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignObjectives()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer assignment
operations to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignObjectivesToObjectiveBank(Id objectiveBankId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer assignment
operations to unauthorized users.objectiveBankId
- the Id
of the
ObjectiveBank
false
if mapping is not authorized, true
otherwiseNullArgumentException
- objectiveBankId
is null
mandatory
- This method must be implemented. IdList getAssignableObjectiveBankIds(Id objectiveBankId) throws OperationFailedException
objectiveBankId
- the Id
of the
ObjectiveBank
Ids
NullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableObjectiveBankIdsForObjective(Id objectiveBankId, Id objectiveId) throws OperationFailedException
objectiveBankId
- the Id
of the
ObjectiveBank
objectiveId
- the Id
of the Objective
Ids
NullArgumentException
- objectiveId
or
objectiveBankId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignObjectiveToObjectiveBank(Id objectiveId, Id objectiveBankId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Objective
to an ObjectiveBank.
objectiveId
- the Id
of the Objective
objectiveBankId
- the Id
of the
ObjectiveBank
AlreadyExistsException
- objectiveId
already mapped to objectiveBankId
NotFoundException
- objectiveId
or
objectiveBankId
not foundNullArgumentException
- objectiveId
or
objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignObjectiveFromObjectiveBank(Id objectiveId, Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Objective
from an ObjectiveBank.
objectiveId
- the Id
of the Objective
objectiveBankId
- the Id
of the
ObjectiveBank
NotFoundException
- objectiveId
or
objectiveBankId
not found or objectiveId
not mapped to objectiveBankId
NullArgumentException
- objectiveId
or
objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignProficiencyToObjectiveBank(Id objectiveId, Id fromObjectiveBankId, Id toObjectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Objective
from one ObjectiveBank
to another. Mappings to other ObjectiveBanks
are unaffected.objectiveId
- the Id
of the Objective
fromObjectiveBankId
- the Id
of the current
ObjectiveBank
toObjectiveBankId
- the Id
of the destination
ObjectiveBank
NotFoundException
- objectiveId,
fromObjectiveBankId,
or toObjectiveBankId
not found or objectiveId
not mapped to
fromObjectiveBankId
NullArgumentException
- objectiveId,
fromObjectiveBankId,
or toObjectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.