Interface BankHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BankHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildBank(Id bankId, Id childId)	Adds a child to a bank.
void	addRootBank(Id bankId)	Adds a root bank.
boolean	canModifyBankHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getBankHierarchy()	Gets the hierarchy associated with this session.
Id	getBankHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildBank(Id bankId, Id childId)	Removes a child from a bank.
void	removeChildBanks(Id bankId)	Removes all children from a bank.
void	removeRootBank(Id bankId)	Removes a root bank from this hierarchy.

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

getBankHierarchyId

Id getBankHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBankHierarchy

Hierarchy getBankHierarchy()
                    throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - assessment failure

Compliance:

mandatory - This method must be implemented.

canModifyBankHierarchy

boolean canModifyBankHierarchy()

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.

addRootBank

void addRootBank(Id bankId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root bank.

Parameters:

bankId - the Id of a bank

Throws:

AlreadyExistsException - bankId is already in hierarchy

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeRootBank

void removeRootBank(Id bankId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root bank from this hierarchy.

Parameters:

bankId - the Id of a bank

Throws:

NotFoundException - bankId not a parent of childId

NullArgumentException - bankId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildBank

void addChildBank(Id bankId,
 Id childId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a bank.

Parameters:

bankId - the Id of a bank

childId - the Id of the new child

Throws:

AlreadyExistsException - bankId is already a parent of childId

NotFoundException - bankId or childId not found

NullArgumentException - bankId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeChildBank

void removeChildBank(Id bankId,
 Id childId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a bank.

Parameters:

bankId - the Id of a bank

childId - the Id of the new child

Throws:

NotFoundException - bankId not parent of childId

NullArgumentException - bankId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeChildBanks

void removeChildBanks(Id bankId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a bank.

Parameters:

bankId - the Id of a bank

Throws:

NotFoundException - bankId is not in hierarchy

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.