Interface AddressBookHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AddressBookHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of AddressBooks . Each node in the hierarchy is a unique AddressBook . The hierarchy may be traversed recursively to establish the tree structure through getParentAddressBooks() and getChildAddressBooks() . To relate these Ids to another OSID, getAddressBookNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any AddressBook available in the Contact OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentAddressBooks() or getChildAddressBooks() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: address book elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessAddressBookHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getAddressBookHierarchy()	Gets the hierarchy associated with this session.
Id	getAddressBookHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getAddressBookNodeIds(Id addressBookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given address book.
AddressBookNode	getAddressBookNodes(Id addressBookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given address book.
IdList	getChildAddressBookIds(Id addressBookId)	Gets the child Ids of the given address book.
AddressBookList	getChildAddressBooks(Id addressBookId)	Gets the child address books of the given id .
IdList	getParentAddressBookIds(Id addressBookId)	Gets the parent Ids of the given address book.
AddressBookList	getParentAddressBooks(Id addressBookId)	Gets the parent address books of the given id .
IdList	getRootAddressBookIds()	Gets the root address book Ids in this hierarchy.
AddressBookList	getRootAddressBooks()	Gets the root address books in the address book hierarchy.
boolean	hasChildAddressBooks(Id addressBookId)	Tests if an address book has any children.
boolean	hasParentAddressBooks(Id addressBookId)	Tests if the AddressBook has any parents.
boolean	isAncestorOfAddressBook(Id id, Id addressBookId)	Tests if an Id is an ancestor of an address book.
boolean	isChildOfAddressBook(Id id, Id addressBookId)	Tests if an address book is a direct child of another.
boolean	isDescendantOfAddressBook(Id id, Id addressBookId)	Tests if an Id is a descendant of an address book.
boolean	isParentOfAddressBook(Id id, Id addressBookId)	Tests if an Id is a direct parent of address book.
void	useComparativeAddressBookView()	The returns from the address book methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryAddressBookView()	A complete view of the AddressBook returns is desired.

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.

canAccessAddressBookHierarchy

boolean canAccessAddressBookHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAddressBookView

void useComparativeAddressBookView()

The returns from the address book methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryAddressBookView

void usePlenaryAddressBookView()

A complete view of the AddressBook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootAddressBookIds

IdList getRootAddressBookIds()
                      throws OperationFailedException,
PermissionDeniedException

Gets the root address book Ids in this hierarchy.

Returns:

the root address book Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootAddressBooks

AddressBookList getRootAddressBooks()
                             throws OperationFailedException,
PermissionDeniedException

Gets the root address books in the address book hierarchy. A node with no parents is an orphan. While all address book Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root address books

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentAddressBooks

boolean hasParentAddressBooks(Id addressBookId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the AddressBook has any parents.

Parameters:

addressBookId - an address book Id

Returns:

true if the address book has parents, f alse otherwise

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfAddressBook

boolean isParentOfAddressBook(Id id,
 Id addressBookId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of address book.

Parameters:

id - an Id

addressBookId - the Id of an address book

Returns:

true if this id is a parent of addressBookId , f alse otherwise

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - id or addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentAddressBookIds

IdList getParentAddressBookIds(Id addressBookId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given address book.

Parameters:

addressBookId - an address book Id

Returns:

the parent Ids of the address book

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentAddressBooks

AddressBookList getParentAddressBooks(Id addressBookId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent address books of the given id .

Parameters:

addressBookId - the Id of the AddressBook to query

Returns:

the parent address books of the id

Throws:

NotFoundException - an AddressBook identified by Id is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfAddressBook

boolean isAncestorOfAddressBook(Id id,
 Id addressBookId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an address book.

Parameters:

id - an Id

addressBookId - the Id of an address book

Returns:

true if this id is an ancestor of addressBookId , false otherwise

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - id or addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildAddressBooks

boolean hasChildAddressBooks(Id addressBookId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an address book has any children.

Parameters:

addressBookId - an address book Id

Returns:

true if the addressBookId has children, false otherwise

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfAddressBook

boolean isChildOfAddressBook(Id id,
 Id addressBookId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an address book is a direct child of another.

Parameters:

id - an Id

addressBookId - the Id of an address book

Returns:

true if the id is a child of addressBookId , false otherwise

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - id or addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildAddressBookIds

IdList getChildAddressBookIds(Id addressBookId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given address book.

Parameters:

addressBookId - the Id to query

Returns:

the children of the address book

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildAddressBooks

AddressBookList getChildAddressBooks(Id addressBookId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child address books of the given id .

Parameters:

addressBookId - the Id of the AddressBook to query

Returns:

the child address books of the id

Throws:

NotFoundException - an AddressBook identified by Id is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfAddressBook

boolean isDescendantOfAddressBook(Id id,
 Id addressBookId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an address book.

Parameters:

id - an Id

addressBookId - the Id of an address book

Returns:

true if the id is a descendant of the addressBookId , false otherwise

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - id or addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getAddressBookNodeIds

Node getAddressBookNodeIds(Id addressBookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given address book.

Parameters:

addressBookId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

an address book node

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAddressBookNodes

AddressBookNode getAddressBookNodes(Id addressBookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given address book.

Parameters:

addressBookId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

an address book node

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.