public interface ProfileHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Profile
objects. Each node in the hierarchy is a unique Profile.
Modifier and Type | Method and Description |
---|---|
void |
addChildProfile(Id profileId,
Id childId)
Adds a child to a profile.
|
void |
addRootProfile(Id profileId)
Adds a root profile.
|
boolean |
canModifyProfileHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getProfileHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getProfileHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildProfile(Id profileId,
Id childId)
Removes a child from a profile.
|
void |
removeChildProfiles(Id profileId)
Removes all children from a profile.
|
void |
removeRootProfile(Id profileId)
Removes a root profile.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getProfileHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getProfileHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyProfileHierarchy()
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 addRootProfile(Id profileId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
profileId
- the Id
of a profileAlreadyExistsException
- profileId
is
already in hierarchyNotFoundException
- profileId
not foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileId
- the Id
of a profileNotFoundException
- profileId
not a rootNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildProfile(Id profileId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
profileId
- the Id
of a profilechildId
- the Id
of the new childAlreadyExistsException
- profileId
is
already a parent of childId
NotFoundException
- profileId
or
childId
not foundNullArgumentException
- profileId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildProfile(Id profileId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileId
- the Id
of a profilechildId
- the Id
of the new childNotFoundException
- profileId
not a
parent of childId
NullArgumentException
- profileId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildProfiles(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
profileId
- the Id
of a profileNotFoundException
- profileId
not in
hierarchyNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.