public interface CampusHierarchyDesignSession extends OsidSession
This session manages a hierarchy of campuses. Campuses may be organized
into a hierarchy for organizing or federating. A parent Campus
includes all of the rooms of its children such that a single root
node contains all of the rooms of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildCampus(Id campusId,
Id childId)
Adds a child to a campus.
|
void |
addRootCampus(Id campusId)
Adds a root campus.
|
boolean |
canModifyCampusHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getCampusHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getCampusHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildCampus(Id campusId,
Id childId)
Removes a child from a campus.
|
void |
removeChildCampuses(Id campusId)
Removes all children from a campus.
|
void |
removeRootCampus(Id campusId)
Removes a root campus.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getCampusHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyCampusHierarchy()
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 addRootCampus(Id campusId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
campusId
- the Id
of a campusAlreadyExistsException
- campusId
is
already in hierarchyNotFoundException
- campusId
is not
foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootCampus(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
campusId
- the Id
of a campusNotFoundException
- campusId
is not a
rootNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildCampus(Id campusId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
campusId
- the Id
of a campuschildId
- the Id
of the new childAlreadyExistsException
- campusId
is
already a parent of childId
NotFoundException
- campusId
or
childId
not foundNullArgumentException
- campusId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCampus(Id campusId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
campusId
- the Id
of a campuschildId
- the Id
of the new childNotFoundException
- campusId
not a
parent of childId
NullArgumentException
- campusId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCampuses(Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
campusId
- the Id
of a campusNotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.