Interface ActivityHierarchyDesignSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session defines methods for managing a hierarchy of
Activities . Each node in the hierarchy is a unique Activity .
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildActivity(Id activityId, Id childId) Adds a child to an activity.voidaddRootActivity(Id activityId) Adds a root activity.booleanTests if this user can change the hierarchy.Gets the hierarchy associated with this session.Gets the hierarchyIdassociated with this session.voidreassignActivityToBusiness(Id activityId, Id fromBusinessId, Id toBusinessId) Moves anActivityfrom oneBusinessto another.voidremoveChildActivities(Id activityId) Removes all children from an activity.voidremoveChildActivity(Id activityId, Id childId) Removes a child from an activity.voidremoveRootActivity(Id activityId) Removes a root activity.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
-
getActivityHierarchyId
Id getActivityHierarchyId()Gets the hierarchyIdassociated with this session.- Returns:
- the hierarchy
Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getActivityHierarchy
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.
-
canModifyActivityHierarchy
boolean canModifyActivityHierarchy()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.
-
addRootActivity
void addRootActivity(Id activityId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a root activity.- Parameters:
activityId- theIdof an activity- Throws:
AlreadyExistsException-activityIdis already in hierarchyNotFoundException-activityIdnot foundNullArgumentException-activityIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeRootActivity
void removeRootActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a root activity.- Parameters:
activityId- theIdof an activity- Throws:
NotFoundException-activityIdnot foundNullArgumentException-activityIdisnullOperationFailedException- the root activitiesPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
addChildActivity
void addChildActivity(Id activityId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a child to an activity.- Parameters:
activityId- theIdof an activitychildId- theIdof the new child- Throws:
AlreadyExistsException-activityIdis already a parent ofchildIdNotFoundException-activityIdorchildIdnot foundNullArgumentException-activityIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildActivity
void removeChildActivity(Id activityId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a child from an activity.- Parameters:
activityId- theIdof an activitychildId- theIdof the new child- Throws:
NotFoundException-activityIdnot a parent ofchildIdNullArgumentException-activityIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildActivities
void removeChildActivities(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes all children from an activity.- Parameters:
activityId- theIdof an activity- Throws:
NotFoundException-activityIdnot foundNullArgumentException-activityIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
reassignActivityToBusiness
void reassignActivityToBusiness(Id activityId, Id fromBusinessId, Id toBusinessId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Moves anActivityfrom oneBusinessto another. Mappings to otherBusinessesare unaffected.- Parameters:
activityId- theIdof theActivityfromBusinessId- theIdof the currentBusinesstoBusinessId- theIdof the destinationBusiness- Throws:
AlreadyExistsException-activityIdalready assigned to toBusinessIdNotFoundException-activityId, fromBusinessId, ortoBusinessIdnot found oractivityIdnot mapped tofromBusinessIdNullArgumentException-activityId, fromBusinessId, ortoBusinessIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-