public interface LocationHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Location
objects. Each node in the hierarchy is a unique
Location.
Modifier and Type | Method and Description |
---|---|
void |
addChildLocation(Id locationId,
Id childId)
Adds a child to a location.
|
void |
addRootLocation(Id locationId)
Adds a root location.
|
boolean |
canModifyLocationHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getLocationHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getLocationHierarchyId()
Gets the hierarchy
Id associated with this session. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getLocationHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getLocationHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyLocationHierarchy()
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 addRootLocation(Id locationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
locationId
- the Id
of a locationAlreadyExistsException
- locationId
is
already in hierarchyNotFoundException
- locationId
not foundNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildLocation(Id locationId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
locationId
- the Id
of a locationchildId
- the Id
of the new childAlreadyExistsException
- mapId
is
already a parent of childId
NotFoundException
- locationId
not foundNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.