org.osid.financials

Interface AccountHierarchyDesignSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AccountHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Account objects. Each node in the hierarchy is a unique Account.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildAccount(Id accountId, Id childId) Adds a child to an account.
void	addRootAccount(Id accountId) Adds a root account.
boolean	canModifyAccountHierarchy() Tests if this user can change the hierarchy.
Hierarchy	getAccountHierarchy() Gets the hierarchy associated with this session.
Id	getAccountHierarchyId() Gets the hierarchy Id associated with this session.
void	removeChildAccount(Id accountId, Id childId) Removes a child from an account.
void	removeChildAccounts(Id accountId) Removes all children from an account.
void	removeRootAccount(Id accountId) Removes a root account.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canModifyAccountHierarchy

boolean canModifyAccountHierarchy()

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.

addRootAccount

void addRootAccount(Id accountId)
                    throws AlreadyExistsException,
                           NotFoundException,
                           OperationFailedException,
                           PermissionDeniedException

Adds a root account.

Parameters:

accountId - the Id of an account

Throws:

AlreadyExistsException - accountId is already in hierarchy

NotFoundException - accountId not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootAccount

void removeRootAccount(Id accountId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Removes a root account.

Parameters:

accountId - the Id of an account

Throws:

NotFoundException - accountId not found

NullArgumentException - accountId is null

OperationFailedException - the root accounts

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildAccount

void addChildAccount(Id accountId,
                   Id childId)
                     throws AlreadyExistsException,
                            NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Adds a child to an account.

Parameters:

accountId - the Id of an account

childId - the Id of the new child

Throws:

AlreadyExistsException - accountId is already a parent of childId

NotFoundException - accountId or childId not found

NullArgumentException - accountId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAccount

void removeChildAccount(Id accountId,
                      Id childId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Removes a child from an account.

Parameters:

accountId - the Id of an account

childId - the Id of the new child

Throws:

NotFoundException - accountId not a parent of childId

NullArgumentException - accountId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAccounts

void removeChildAccounts(Id accountId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Removes all children from an account.

Parameters:

accountId - the Id of an account

Throws:

NotFoundException - accountId not found

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.