public interface FamilyHierarchyDesignSession extends OsidSession
This session manages a hierarchy of families may be organized into a
hierarchy for organizing or federating. A parent Family
includes all of the relationships of its children such that a single root
node contains all of the relationships of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildFamily(Id familyId,
Id childId)
Adds a child to a family.
|
void |
addRootFamily(Id familyId)
Adds a root family.
|
boolean |
canModifyFamilyHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getFamilyHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getFamilyHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildFamilies(Id familyId)
Removes all children from a family.
|
void |
removeChildFamily(Id familyId,
Id childId)
Removes a child from a family.
|
void |
removeRootFamily(Id familyId)
Removes a root family.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFamilyHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getFamilyHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyFamilyHierarchy()
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 addRootFamily(Id familyId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
familyId
- the Id
of a familyAlreadyExistsException
- familyId
is
already in hierarchyNotFoundException
- familyId
not foundNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootFamily(Id familyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
familyId
- the Id
of a familyNotFoundException
- familyId
not a rootNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildFamily(Id familyId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
familyId
- the Id
of a familychildId
- the Id
of the new childAlreadyExistsException
- familyId
is
already a parent of childId
NotFoundException
- familyId
or
childId
not foundNullArgumentException
- familyId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildFamily(Id familyId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
familyId
- the Id
of a familychildId
- the Id
of the new childNotFoundException
- familyId
not a
parent of childId
NullArgumentException
- familyId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildFamilies(Id familyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
familyId
- the Id
of a familyNotFoundException
- familyId
not in
hierarchyNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.