public interface RealmHierarchyDesignSession extends OsidSession
This session manages a hierarchy of realms. Realms may be organized
into a hierarchy for organizing or federating. A parent Realm
includes all of the persons of its children such that a single
root node contains all of the persons of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildRealm(Id realmId,
Id childId)
Adds a child to a realm.
|
void |
addRootRealm(Id realmId)
Adds a root realm.
|
boolean |
canModifyRealmHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getRealmHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getRealmHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildRealm(Id realmId,
Id childId)
Removes a child from a realm.
|
void |
removeChildRealms(Id realmId)
Removes all children from a realm.
|
void |
removeRootRealm(Id realmId)
Removes a root realm.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRealmHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getRealmHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyRealmHierarchy()
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 addRootRealm(Id realmId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
realmId
- the Id
of a realmAlreadyExistsException
- realmId
is
already in hierarchyNotFoundException
- realmId
is not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootRealm(Id realmId) throws NotFoundException, OperationFailedException, PermissionDeniedException
realmId
- the Id
of a realmNotFoundException
- realmId
is not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildRealm(Id realmId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
realmId
- the Id
of a realmchildId
- the Id
of the new childAlreadyExistsException
- realmId
is
already a parent of childId
NotFoundException
- realmId
or
childId
not foundNullArgumentException
- realmId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildRealm(Id realmId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
realmId
- the Id
of a realmchildId
- the Id
of the new childNotFoundException
- realmId
not a parent
of childId
NullArgumentException
- realmId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildRealms(Id realmId) throws NotFoundException, OperationFailedException, PermissionDeniedException
realmId
- the Id
of a realmNotFoundException
- realmId
is not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.