Interface AddressBookHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAddressBookHierarchyId

Id getAddressBookHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAddressBookHierarchy

Hierarchy getAddressBookHierarchy()
                           throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyAddressBookHierarchy

boolean canModifyAddressBookHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootAddressBook

void addRootAddressBook(Id addressBookId)
                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root address book.

Parameters:

addressBookId - the Id of an address book

Throws:

AlreadyExistsException - addressBookId is already in hierarchy

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootAddressBook

void removeRootAddressBook(Id addressBookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root address book.

Parameters:

addressBookId - the Id of an address book

Throws:

NotFoundException - addressBookId is not a root

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildAddressBook

void addChildAddressBook(Id addressBookId,
 Id childId)
                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an address book.

Parameters:

addressBookId - the Id of an address book

childId - the Id of the new child

Throws:

AlreadyExistsException - addressBookId is already a parent of childId

NotFoundException - addressBookId or childId not found

NullArgumentException - addressBookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAddressBook

void removeChildAddressBook(Id addressBookId,
 Id childId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an address book.

Parameters:

addressBookId - the Id of an address book

childId - the Id of the new child

Throws:

NotFoundException - addressBookId not a parent of childId

NullArgumentException - addressBookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAddressBooks

void removeChildAddressBooks(Id addressBookId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an address book.

Parameters:

addressBookId - the Id of an address book

Throws:

NotFoundException - addressBookId not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.