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