Interface UtilityHierarchyDesignSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session manages a hierarchy of utilities. Utilities may be
organized into a hierarchy for organizing or federating. A parent
Utility includes all of the Ids of its children such that a single root
node contains all of the Ids of the federation.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildUtility(Id utilityId, Id childId) Adds a child to a utility.voidaddRootUtility(Id utilityId) Adds a root utility.booleanTests if this user can change the hierarchy.Gets the hierarchy associated with this session.Gets the hierarchyIdassociated with this session.voidremoveChildUtilities(Id utilityId) Removes all children from a utility.voidremoveChildUtility(Id utilityId, Id childId) Removes a child from a utility.voidremoveRootUtility(Id utilityId) Removes a root utility.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
-
getUtilityHierarchyId
Id getUtilityHierarchyId()Gets the hierarchyIdassociated with this session.- Returns:
- the hierarchy
Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getUtilityHierarchy
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.
-
canModifyUtilityHierarchy
boolean canModifyUtilityHierarchy()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.
-
addRootUtility
void addRootUtility(Id utilityId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a root utility.- Parameters:
utilityId- theIdof a utility- Throws:
AlreadyExistsException-utilityIdis already in hierarchyNotFoundException-utilityIdnot foundNullArgumentException-utilityIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeRootUtility
void removeRootUtility(Id utilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a root utility.- Parameters:
utilityId- theIdof a utility- Throws:
NotFoundException-utilityIdis not a rootNullArgumentException-utilityIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
addChildUtility
void addChildUtility(Id utilityId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a child to a utility.- Parameters:
utilityId- theIdof a utilitychildId- theIdof the new child- Throws:
AlreadyExistsException-utilityIdis already a parent ofchildIdNotFoundException-utilityIdorchildIdnot foundNullArgumentException-utilityIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildUtility
void removeChildUtility(Id utilityId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a child from a utility.- Parameters:
utilityId- theIdof a utilitychildId- theIdof the new child- Throws:
NotFoundException-utilityIdnot a parent ofchildIdNullArgumentException-utilityIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildUtilities
void removeChildUtilities(Id utilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes all children from a utility.- Parameters:
utilityId- theIdof a utility- Throws:
NotFoundException-utilityIdnot foundNullArgumentException-utilityIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-