Interface AccountHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AccountHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Accounts . Each node in the hierarchy is a unique Account . The hierarchy may be traversed recursively to establish the tree structure through getAccountNodes() . To relate these Ids to another OSID, getAncestorAccounts() and getDescendantAccounts() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Account available in the Business 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 getParentAccounts() or getChildAccounts() 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: account 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	canAccessAccountHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getAccountHierarchy()	Gets the hierarchy associated with this session.
Id	getAccountHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getAccountNodeIds(Id accountId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given account.
AccountNode	getAccountNodes(Id accountId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given account.
IdList	getChildAccountIds(Id accountId)	Gets the child Ids of the given account.
AccountList	getChildAccounts(Id accountId)	Gets the children of the given account.
IdList	getParentAccountIds(Id accountId)	Gets the parent Ids of the given account.
AccountList	getParentAccounts(Id accountId)	Gets the parents of the given account.
IdList	getRootAccountIds()	Gets the root account Ids in this hierarchy.
AccountList	getRootAccounts()	Gets the root accounts in this account hierarchy.
boolean	hasChildAccounts(Id accountId)	Tests if an account has any children.
boolean	hasParentAccounts(Id accountId)	Tests if the Account has any parents.
boolean	isAncestorOfAccount(Id id, Id accountId)	Tests if an Id is an ancestor of an account.
boolean	isChildOfAccount(Id id, Id accountId)	Tests if an account is a direct child of another.
boolean	isDescendantOfAccount(Id id, Id accountId)	Tests if an Id is a descendant of an account.
boolean	isParentOfAccount(Id id, Id accountId)	Tests if an Id is a direct parent of an account.
void	useComparativeAccountView()	The returns from the account methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryAccountView()	A complete view of the Hierarchy 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

getAccountHierarchyId

Id getAccountHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAccountHierarchy

Hierarchy getAccountHierarchy()
                       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.

canAccessAccountHierarchy

boolean canAccessAccountHierarchy()

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 traversal operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAccountView

void useComparativeAccountView()

The returns from the account 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.

usePlenaryAccountView

void usePlenaryAccountView()

A complete view of the Hierarchy 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.

getRootAccountIds

IdList getRootAccountIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root account Ids in this hierarchy.

Returns:

the root account Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootAccounts

AccountList getRootAccounts()
                     throws OperationFailedException,
PermissionDeniedException

Gets the root accounts in this account hierarchy.

Returns:

the root accounts

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentAccounts

boolean hasParentAccounts(Id accountId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Account has any parents.

Parameters:

accountId - the Id of an account

Returns:

true if the account has parents, false otherwise

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfAccount

boolean isParentOfAccount(Id id,
 Id accountId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of an account.

Parameters:

id - an Id

accountId - the Id of an account

Returns:

true if this id is a parent of accountId , false otherwise

Throws:

NotFoundException - accountId is not found

NullArgumentException - id or accountId 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} .

getParentAccountIds

IdList getParentAccountIds(Id accountId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given account.

Parameters:

accountId - the Id of an account

Returns:

the parent Ids of the account

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentAccounts

AccountList getParentAccounts(Id accountId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given account.

Parameters:

accountId - the Id of an account

Returns:

the parents of the account

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfAccount

boolean isAncestorOfAccount(Id id,
 Id accountId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an account.

Parameters:

id - an Id

accountId - the Id of an account

Returns:

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

Throws:

NotFoundException - accountId is not found

NullArgumentException - id or accountId 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} .

hasChildAccounts

boolean hasChildAccounts(Id accountId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an account has any children.

Parameters:

accountId - the Id of an account

Returns:

true if the accountId has children, false otherwise

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfAccount

boolean isChildOfAccount(Id id,
 Id accountId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an account is a direct child of another.

Parameters:

id - an Id

accountId - the Id of an account

Returns:

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

Throws:

NotFoundException - accountId is not found

NullArgumentException - id or accountId 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} .

getChildAccountIds

IdList getChildAccountIds(Id accountId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given account.

Parameters:

accountId - the Id to query

Returns:

the children of the account

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildAccounts

AccountList getChildAccounts(Id accountId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given account.

Parameters:

accountId - the Id to query

Returns:

the children of the account

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfAccount

boolean isDescendantOfAccount(Id id,
 Id accountId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an account.

Parameters:

id - an Id

accountId - the Id of an account

Returns:

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

Throws:

NotFoundException - accountId is not found

NullArgumentException - id or accountId 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} .

getAccountNodeIds

Node getAccountNodeIds(Id accountId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given account.

Parameters:

accountId - 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 account node

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAccountNodes

AccountNode getAccountNodes(Id accountId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given account.

Parameters:

accountId - 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 account node

Throws:

NotFoundException - accountId is not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.