public interface ActivityHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Activity
objects. Each node in the hierarchy is a unique
Activity.
Modifier and Type | Method and Description |
---|---|
void |
addChildActivity(Id activityId,
Id childId)
Adds a child to an activity.
|
void |
addRootActivity(Id activityId)
Adds a root activity.
|
boolean |
canModifyActivityHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getActivityHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getActivityHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildActivities(Id activityId)
Removes all children from an activity.
|
void |
removeChildActivity(Id activityId,
Id childId)
Removes a child from an activity.
|
void |
removeRootActivity(Id activityId)
Removes a root activity.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getActivityHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getActivityHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyActivityHierarchy()
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 addRootActivity(Id activityId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
activityId
- the Id
of an activityAlreadyExistsException
- activityId
is
already in hierarchyNotFoundException
- activityId
not foundNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityId
- the Id
of an activityNotFoundException
- activityId
not foundNullArgumentException
- activityId
is
null
OperationFailedException
- the root activitiesPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildActivity(Id activityId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
activityId
- the Id
of an activitychildId
- the Id
of the new childAlreadyExistsException
- activityId
is
already a parent of childId
NotFoundException
- activityId
or
childId
not foundNullArgumentException
- activityId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildActivity(Id activityId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityId
- the Id
of an activitychildId
- the Id
of the new childNotFoundException
- activityId
not a
parent of childId
NullArgumentException
- activityId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildActivities(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityId
- the Id
of an activityNotFoundException
- activityId
not foundNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.