public interface ObjectiveBankHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
ObjectiveBank
objects. Each node in the hierarchy is a unique
ObjectiveBank.
Modifier and Type | Method and Description |
---|---|
void |
addChildObjectiveBank(Id objectiveBankId,
Id childId)
Adds a child to an objective bank.
|
void |
addRootObjectiveBank(Id objectiveBankId)
Adds a root objective bank.
|
boolean |
canModifyObjectiveBankHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getObjectiveBankHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getObjectiveBankHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildObjectiveBank(Id objectiveBankId,
Id childId)
Removes a child from an objective bank.
|
void |
removeChildObjectiveBanks(Id objectiveBankId)
Removes all children from an objective bank.
|
void |
removeRootObjectiveBank(Id objectiveBankId)
Removes a root objective bank.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getObjectiveBankHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getObjectiveBankHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyObjectiveBankHierarchy()
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 addRootObjectiveBank(Id objectiveBankId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
objectiveBankId
- the Id
of an objective bankAlreadyExistsException
- objectiveBankId
is already in hierarchyNotFoundException
- objectiveBankId
not
foundNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveBankId
- the Id
of an objective bankNotFoundException
- objectiveBankId
is
not a rootNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildObjectiveBank(Id objectiveBankId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
objectiveBankId
- the Id
of an objective bankchildId
- the Id
of the new childAlreadyExistsException
- objectiveBankId
is already a parent of childId
NotFoundException
- objectiveBankId
or
childId
not foundNullArgumentException
- objectiveBankId
or childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildObjectiveBank(Id objectiveBankId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveBankId
- the Id
of an objective bankchildId
- the Id
of the childNotFoundException
- objectiveBankId
not
a parent of childId
NullArgumentException
- objectiveBankId
or childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildObjectiveBanks(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
objectiveBankId
- the Id
of an objective bankNotFoundException
- objectiveBankId
not
in hierarchyNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.