public interface ObjectiveHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Objective
objects. Each node in the hierarchy is a unique
Objective.
Modifier and Type | Method and Description |
---|---|
void |
addChildObjective(Id objectiveId,
Id childId)
Adds a child to an objective.
|
void |
addRootObjective(Id objectiveId)
Adds a root objective.
|
boolean |
canModifyObjectiveHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getObjectiveHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getObjectiveHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildObjective(Id objectiveId,
Id childId)
Removes a child from an objective.
|
void |
removeChildObjectives(Id objectiveId)
Removes all children from an objective.
|
void |
removeRootObjective(Id objectiveId)
Removes a root objective.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getObjectiveHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getObjectiveHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyObjectiveHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootObjective(Id objectiveId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of an objectiveAlreadyExistsException
- objectiveId
is
already in hierarchyNotFoundException
- objectiveId
not
foundNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootObjective(Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of an objectiveNotFoundException
- objectiveId
not
foundNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildObjective(Id objectiveId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of an objectivechildId
- the Id
of the new childAlreadyExistsException
- objectiveId
is
already a parent of childId
NotFoundException
- objectiveId
or
childId
not foundNullArgumentException
- objectiveId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildObjective(Id objectiveId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of an objectivechildId
- the Id
of the new childNotFoundException
- objectiveId
not a
parent of childId
NullArgumentException
- objectiveId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildObjectives(Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveId
- the Id
of an objectiveNotFoundException
- objectiveId
not
foundNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.