public interface AddressBookHierarchyDesignSession extends OsidSession
This session manages a hierarchy of address books. AddressBooks may be
organized into a hierarchy for organizing or federating. A parent
AddressBook
includes all of the contacts of its children such that
a single root node contains all of the contacts of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildAddressBook(Id addressBookId,
Id childId)
Adds a child to an address book.
|
void |
addRootAddressBook(Id addressBookId)
Adds a root address book.
|
boolean |
canModifyAddressBookHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getAddressBookHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getAddressBookHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildAddressBook(Id addressBookId,
Id childId)
Removes a child from an address book.
|
void |
removeChildAddressBooks(Id addressBookId)
Removes all children from an address book.
|
void |
removeRootAddressBook(Id addressBookId)
Removes a root address book.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAddressBookHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getAddressBookHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyAddressBookHierarchy()
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 addRootAddressBook(Id addressBookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
addressBookId
- the Id
of an address bookAlreadyExistsException
- addressBookId
is already in hierarchyNotFoundException
- addressBookId
is not
foundNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
addressBookId
- the Id
of an address bookNotFoundException
- addressBookId
is not
a rootNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildAddressBook(Id addressBookId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
addressBookId
- the Id
of an address bookchildId
- the Id
of the new childAlreadyExistsException
- addressBookId
is already a parent of childId
NotFoundException
- addressBookId
or
childId
not foundNullArgumentException
- addressBookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAddressBook(Id addressBookId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
addressBookId
- the Id
of an address bookchildId
- the Id
of the new childNotFoundException
- addressBookId
not a
parent of childId
NullArgumentException
- addressBookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAddressBooks(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
addressBookId
- the Id
of an address bookNotFoundException
- addressBookId
not
foundNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.