public interface OfficeHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Office
objects. Each node in the hierarchy is a unique Office.
Modifier and Type | Method and Description |
---|---|
void |
addChildOffice(Id officeId,
Id childId)
Adds a child to an office.
|
void |
addRootOffice(Id officeId)
Adds a root office.
|
boolean |
canModifyOfficeHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getOfficeHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getOfficeHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildOffice(Id officeId,
Id childId)
Removes a child from an office.
|
void |
removeChildOffices(Id officeId)
Removes all children from an office.
|
void |
removeRootOffice(Id officeId)
Removes a root office.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getOfficeHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyOfficeHierarchy()
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 addRootOffice(Id officeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
officeId
- the Id
of an officeAlreadyExistsException
- officeId
is
already in hierarchyNotFoundException
- officeId
not foundNullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
officeId
- the Id
of an officeNotFoundException
- officeId
is not a
rootNullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildOffice(Id officeId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
officeId
- the Id
of an officechildId
- the Id
of the new childAlreadyExistsException
- officeId
is
already a parent of childId
NotFoundException
- officeId
or
childId
not foundNullArgumentException
- officeId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildOffice(Id officeId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
officeId
- the Id
of an officechildId
- the Id
of the new childNotFoundException
- officeId
is not
parent of childId
NullArgumentException
- officeId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildOffices(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
officeId
- the Id
of an officeNotFoundException
- officeId
is not
foundNullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.