OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Account objects. 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
MethodgetAccountHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAccountHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessAccountHierarchy
Description

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.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAccountView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAccountView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetRootAccountIds
Description

Gets the root account Ids in this hierarchy.

Returnosid.id.IdListthe root account Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootAccounts
Description

Gets the root accounts in this account hierarchy.

Returnosid.financials.AccountListthe root accounts
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentAccounts
Description

Tests if the Account has any parents.

Parametersosid.id.IdaccountIdthe Id of an account
Returnboolean true if the account has parents, false otherwise
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfAccount
Description

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

Parametersosid.id.Ididan Id
osid.id.IdaccountIdthe Id of an account
Returnboolean true if this id is a parent of accountId, false otherwise
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT id or accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentAccountIds
Description

Gets the parent Ids of the given account.

Parametersosid.id.IdaccountIdthe Id of an account
Returnosid.id.IdListthe parent Ids of the account
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentAccounts
Description

Gets the parents of the given account.

Parametersosid.id.IdaccountIdthe Id of an account
Returnosid.financials.AccountListthe parents of the account
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfAccount
Description

Tests if an Id is an ancestor of an account.

Parametersosid.id.Ididan Id
osid.id.IdaccountIdthe Id of an account
Returnboolean true if this id is an ancestor of accountId, false otherwise
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT id or accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildAccounts
Description

Tests if an account has any children.

Parametersosid.id.IdaccountIdthe Id of an account
Returnboolean true if the accountId has children, false otherwise
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfAccount
Description

Tests if an account is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdaccountIdthe Id of an account
Returnboolean true if the id is a child of accountId, false otherwise
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT id or accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildAccountIds
Description

Gets the child Ids of the given account.

Parametersosid.id.IdaccountIdthe Id to query
Returnosid.id.IdListthe children of the account
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildAccounts
Description

Gets the children of the given account.

Parametersosid.id.IdaccountIdthe Id to query
Returnosid.financials.AccountListthe children of the account
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfAccount
Description

Tests if an Id is a descendant of an account.

Parametersosid.id.Ididan Id
osid.id.IdaccountIdthe Id of an account
Returnboolean true if the id is a descendant of the accountId, false otherwise
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT id or accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetAccountNodeIds
Description

Gets a portion of the hierarchy for the given account.

Parametersosid.id.IdaccountIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodean account node
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccountNodes
Description

Gets a portion of the hierarchy for the given account.

Parametersosid.id.IdaccountIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.financials.AccountNodean account node
ErrorsNOT_FOUND accountId is not found
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.