Interface BankHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BankHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Bank objects. Each node in the hierarchy is a unique Bank . The hierarchy may be traversed recursively to establish the tree structure through getParentBanks() and getChildBanks() . To relate these Ids to another OSID, getBankNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Bank available in the Assessment 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 getParentBanks() or getChildBanks() 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: bank 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	canAccessBankHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getBankHierarchy()	Gets the hierarchy associated with this session.
Id	getBankHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getBankNodeIds(Id bankId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given bank.
BankNode	getBankNodes(Id bankId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given bank.
IdList	getChildBankIds(Id bankId)	Gets the child Ids of the given bank.
BankList	getChildBanks(Id bankId)	Gets the children of the given bank.
IdList	getParentBankIds(Id bankId)	Gets the parent Ids of the given bank.
BankList	getParentBanks(Id bankId)	Gets the parents of the given bank.
IdList	getRootBankIds()	Gets the root bank Ids in this hierarchy.
BankList	getRootBanks()	Gets the root banks in this bank hierarchy.
boolean	hasChildBanks(Id bankId)	Tests if a bank has any children.
boolean	hasParentBanks(Id bankId)	Tests if the Bank has any parents.
boolean	isAncestorOfBank(Id id, Id bankId)	Tests if an Id is an ancestor of a bank.
boolean	isChildOfBank(Id id, Id bankId)	Tests if a bank is a direct child of another.
boolean	isDescendantOfBank(Id id, Id bankId)	Tests if an Id is a descendant of a bank.
boolean	isParentOfBank(Id id, Id bankId)	Tests if an Id is a direct parent of a bank.
void	useComparativeBankView()	The returns from the bank methods may omit or translate elements based on this session, such as assessment, and not result in an error.
void	usePlenaryBankView()	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

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.

canAccessBankHierarchy

boolean canAccessBankHierarchy()

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.

useComparativeBankView

void useComparativeBankView()

The returns from the bank methods may omit or translate elements based on this session, such as assessment, 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.

usePlenaryBankView

void usePlenaryBankView()

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.

getRootBankIds

IdList getRootBankIds()
               throws OperationFailedException,
PermissionDeniedException

Gets the root bank Ids in this hierarchy.

Returns:

the root bank Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getRootBanks

BankList getRootBanks()
               throws OperationFailedException,
PermissionDeniedException

Gets the root banks in this bank hierarchy.

Returns:

the root banks

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method is must be implemented.

hasParentBanks

boolean hasParentBanks(Id bankId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Bank has any parents.

Parameters:

bankId - a bank Id

Returns:

true if the bank has parents, false otherwise

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

isParentOfBank

boolean isParentOfBank(Id id,
 Id bankId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

bankId - the Id of a bank

Returns:

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

Throws:

NotFoundException - bankId is not found

NullArgumentException - id or bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

Notes:

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

getParentBankIds

IdList getParentBankIds(Id bankId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given bank.

Parameters:

bankId - a bank Id

Returns:

the parent Ids of the bank

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getParentBanks

BankList getParentBanks(Id bankId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given bank.

Parameters:

bankId - a bank Id

Returns:

the parents of the bank

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

isAncestorOfBank

boolean isAncestorOfBank(Id id,
 Id bankId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a bank.

Parameters:

id - an Id

bankId - the Id of a bank

Returns:

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

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId 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} .

hasChildBanks

boolean hasChildBanks(Id bankId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a bank has any children.

Parameters:

bankId - a bankId

Returns:

true if the bankId has children, false otherwise

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfBank

boolean isChildOfBank(Id id,
 Id bankId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a bank is a direct child of another.

Parameters:

id - an Id

bankId - the Id of a bank

Returns:

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

Throws:

NotFoundException - bankId not found

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

getChildBankIds

IdList getChildBankIds(Id bankId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given bank.

Parameters:

bankId - the Id to query

Returns:

the children of the bank

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildBanks

BankList getChildBanks(Id bankId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given bank.

Parameters:

bankId - the Id to query

Returns:

the children of the bank

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfBank

boolean isDescendantOfBank(Id id,
 Id bankId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a bank.

Parameters:

id - an Id

bankId - the Id of a bank

Returns:

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

Throws:

NotFoundException - bankId not found

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

getBankNodeIds

Node getBankNodeIds(Id bankId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given bank.

Parameters:

bankId - 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:

a bank node

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBankNodes

BankNode getBankNodes(Id bankId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given bank.

Parameters:

bankId - 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:

a bank node

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.