public interface ObjectiveRequisiteAssignmentSession extends OsidSession
This session provides methods to manage requisites. 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 |
assignEquivalentObjective(Id objectiveId,
Id equivalentObjectiveId)
Makes an objective equivalent to another objective for the purposes of
satisfying a requisite.
|
void |
assignObjectiveRequisite(Id objectiveId,
Id requisiteObjectiveId)
Creates a requirement dependency between two
Objectives. |
boolean |
canAssignRequisites()
Tests if this user can manage objective requisites.
|
ObjectiveBank |
getObjectiveBank()
Gets the
ObjectiveBank associated with this session. |
Id |
getObjectiveBankId()
Gets the
ObjectiveBank Id associated
with this session. |
void |
unassignEquivalentObjective(Id objectiveId,
Id equivalentObjectiveId)
Removes an
Objective requisite from an
Objective. |
void |
unassignObjectiveRequisite(Id objectiveId,
Id requisiteObjectiveId)
Removes an
Objective requisite from an
Objective. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getObjectiveBankId()
ObjectiveBank
Id
associated
with this session. ObjectiveBank Id
associated with this
sessionmandatory
- This method must be implemented. ObjectiveBank getObjectiveBank() throws OperationFailedException, PermissionDeniedException
ObjectiveBank
associated with this session. ObjectiveBank
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignRequisites()
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. void assignObjectiveRequisite(Id objectiveId, Id requisiteObjectiveId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Objectives.
objectiveId
- the Id
of the dependent
Objective
requisiteObjectiveId
- the Id
of the required
Objective
AlreadyExistsException
- objectiveId
already mapped to requisiteObjectiveId
NotFoundException
- objectiveId
or
requisiteObjectiveId
not foundNullArgumentException
- objectiveId
or
requisiteObjectiveId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignObjectiveRequisite(Id objectiveId, Id requisiteObjectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Objective
requisite from an
Objective.
objectiveId
- the Id
of the Objective
requisiteObjectiveId
- the Id
of the required
Objective
NotFoundException
- objectiveId
or
requisiteObjectiveId
not found or
objectiveId
not mapped to requisiteObjectiveId
NullArgumentException
- objectiveId
or
requisiteObjectiveId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void assignEquivalentObjective(Id objectiveId, Id equivalentObjectiveId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of the principal
Objective
equivalentObjectiveId
- the Id
of the equivalent
Objective
AlreadyExistsException
- objectiveId
already mapped to equiavelntObjectiveId
NotFoundException
- objectiveId
or
equivalentObjectiveId
not foundNullArgumentException
- objectiveId
or
equivalentObjectiveId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignEquivalentObjective(Id objectiveId, Id equivalentObjectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Objective
requisite from an
Objective.
objectiveId
- the Id
of the principal
Objective
equivalentObjectiveId
- the Id
of the equivalent
Objective
NotFoundException
- objectiveId
or
equivalentObjectiveId
not found or
objectiveId
is already equivalent to
equivalentObjectiveId
NullArgumentException
- objectiveId
or
equivalentObjectiveId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.