OSID - osid.financials.AccountHierarchyDesignSession Service Interface Definition

Interface	osid.financials.AccountHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.financials.FinancialsManager`
Used By	`osid.financials.FinancialsProxyManager`
Description	This session defines methods for managing a hierarchy of `Accounts`. Each node in the hierarchy is a unique `Account`.
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	canModifyAccountHierarchy
Description	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.
Return	`boolean`		`false` if changing this hierarchy is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addRootAccount
Description	Adds a root account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Errors	ALREADY_EXISTS		`accountId` is already in hierarchy
	NOT_FOUND		`accountId` 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	removeRootAccount
Description	Removes a root account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Errors	NOT_FOUND		`accountId` not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		the root accounts
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildAccount
Description	Adds a child to an account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`accountId` is already a parent of `childId`
	NOT_FOUND		`accountId` or `childId` not found
	NULL_ARGUMENT		`accountId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildAccount
Description	Removes a child from an account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`accountId` not a parent of `childId`
	NULL_ARGUMENT		`accountId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildAccounts
Description	Removes all children from an account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an account
Errors	NOT_FOUND		`accountId` 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	reassignAccountToBusiness
Description	Moves an `Account` from one `Business` to another. Mappings to other `Businesses` are unaffected.
Parameters	`osid.id.Id`	`accountId`	the `Id` of the `Account`
	`osid.id.Id`	`fromBusinessId`	the `Id` of the current `Business`
	`osid.id.Id`	`toBusinessId`	the `Id` of the destination `Business`
Errors	ALREADY_EXISTS		`accountId` already assigned to toB `usinessId`
	NOT_FOUND		`accountId, fromBusinessId`, or `toBusinessId` not found or `accountId` not mapped to `fromBusinessId`
	NULL_ARGUMENT		`accountId, fromBusinessId`, or `toBusinessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.