public interface AcademyHierarchyDesignSession extends OsidSession
This session manages a hierarchy of academies. Academies may be
organized into a hierarchy for organizing or federating. A parent
Academy
includes all of the conferrals of its children such that a
single root node contains all of the conferrals of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildAcademy(Id academyId,
Id childId)
Adds a child to an academy.
|
void |
addRootAcademy(Id academyId)
Adds a root academy.
|
boolean |
canModifyAcademyHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getAcademyHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getAcademyHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildAcademies(Id academyId)
Removes all children from an academy.
|
void |
removeChildAcademy(Id academyId,
Id childId)
Removes a child from an academy.
|
void |
removeRootAcademy(Id academyId)
Removes a root academy.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAcademyHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getAcademyHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyAcademyHierarchy()
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 addRootAcademy(Id academyId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
academyId
- the Id
of an academyAlreadyExistsException
- academyId
is
already in hierarchyNotFoundException
- academyId
is not
foundNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootAcademy(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
academyId
- the Id
of an academyNotFoundException
- academyId
is not a
rootNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildAcademy(Id academyId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
academyId
- the Id
of an academychildId
- the Id
of the new childAlreadyExistsException
- academyId
is
already a parent of childId
NotFoundException
- academyId
or
childId
not foundNullArgumentException
- academyId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAcademy(Id academyId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
academyId
- the Id
of an academychildId
- the Id
of the new childNotFoundException
- academyId
not a
parent of childId
NullArgumentException
- academyId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAcademies(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
academyId
- the Id
of an academyNotFoundException
- academyId
not foundNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.