Interface FrontOfficeHierarchyDesignSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session defines methods for managing a hierarchy of
FrontOffice objects. Each node in the hierarchy is a unique
FrontOffice .
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildFrontOffice(Id frontOfficeId, Id childId) Adds a child to a front office.voidaddRootFrontOffice(Id frontOfficeId) Adds a root front office.booleanTests if this user can change the hierarchy.Gets the hierarchy associated with this session.Gets the hierarchyIdassociated with this session.voidremoveChildFrontOffice(Id frontOfficeId, Id childId) Removes a child from a front office.voidremoveChildFrontOffices(Id frontOfficeId) Removes all children from a front office.voidremoveRootFrontOffice(Id frontOfficeId) Removes a root front office.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getFrontOfficeHierarchyId
Id getFrontOfficeHierarchyId()Gets the hierarchyIdassociated with this session.- Returns:
- the hierarchy
Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getFrontOfficeHierarchy
Gets the hierarchy associated with this session.- Returns:
- the hierarchy associated with this session
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
canModifyFrontOfficeHierarchy
boolean canModifyFrontOfficeHierarchy()Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.- Returns:
falseif changing this hierarchy is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
addRootFrontOffice
void addRootFrontOffice(Id frontOfficeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a root front office.- Parameters:
frontOfficeId- theIdof a front office- Throws:
AlreadyExistsException-frontOfficeIdis already in hierarchyNotFoundException-frontOfficeIdnot foundNullArgumentException-frontOfficeIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeRootFrontOffice
void removeRootFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a root front office.- Parameters:
frontOfficeId- theIdof a front office- Throws:
NotFoundException-frontOfficeIdis not a rootNullArgumentException-frontOfficeIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
addChildFrontOffice
void addChildFrontOffice(Id frontOfficeId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a child to a front office.- Parameters:
frontOfficeId- theIdof a front officechildId- theIdof the new child- Throws:
AlreadyExistsException-frontOfficeIdis already a parent ofchildIdNotFoundException-frontOfficeIdorchildIdnot foundNullArgumentException-frontOfficeIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildFrontOffice
void removeChildFrontOffice(Id frontOfficeId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a child from a front office.- Parameters:
frontOfficeId- theIdof a front officechildId- theIdof the new child- Throws:
NotFoundException-frontOfficeIdis not parent ofchildIdNullArgumentException-frontOfficeIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildFrontOffices
void removeChildFrontOffices(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes all children from a front office.- Parameters:
frontOfficeId- theIdof a front office- Throws:
NotFoundException-frontOfficeIdis not foundNullArgumentException-frontOfficeIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-