OSID - osid.financials.AccountHierarchySession Service Interface Definition

Interface	osid.financials.AccountHierarchySession
Implements	`osid.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
Method	getAccountHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAccountHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessAccountHierarchy
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.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAccountView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryAccountView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	getRootAccountIds
Description	Gets the root account `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root account `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootAccounts
Description	Gets the root accounts in this account hierarchy.
Return	`osid.financials.AccountList`		the root accounts
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentAccounts
Description	Tests if the `Account` has any parents.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`boolean`		`true` if the account has parents, `false` otherwise
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfAccount
Description	Tests if an `Id` is a direct parent of an account.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`boolean`		`true` if this `id` is a parent of `accountId,` `false` otherwise
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`id` or `accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentAccountIds
Description	Gets the parent Ids of the given account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`osid.id.IdList`		the parent `Ids` of the account
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentAccounts
Description	Gets the parents of the given account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`osid.financials.AccountList`		the parents of the account
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfAccount
Description	Tests if an `Id` is an ancestor of an account.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`boolean`		`true` if this `id` is an ancestor of `accountId,` `false` otherwise
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`id` or `accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	hasChildAccounts
Description	Tests if an account has any children.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`boolean`		`true` if the `accountId` has children, `false` otherwise
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfAccount
Description	Tests if an account is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`boolean`		`true` if the `id` is a child of `accountId,` `false` otherwise
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`id` or `accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildAccountIds
Description	Gets the child `Ids` of the given account.
Parameters	`osid.id.Id`	`accountId`	the `Id` to query
Return	`osid.id.IdList`		the children of the account
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildAccounts
Description	Gets the children of the given account.
Parameters	`osid.id.Id`	`accountId`	the `Id` to query
Return	`osid.financials.AccountList`		the children of the account
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfAccount
Description	Tests if an `Id` is a descendant of an account.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Return	`boolean`		`true` if the `id` is a descendant of the `accountId,` `false` otherwise
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`id` or `accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getAccountNodeIds
Description	Gets a portion of the hierarchy for the given account.
Parameters	`osid.id.Id`	`accountId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		an account node
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAccountNodes
Description	Gets a portion of the hierarchy for the given account.
Parameters	`osid.id.Id`	`accountId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.financials.AccountNode`		an account node
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.