OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
financials package
Version 3.0.0
Release Candidate Preview
| Interface | osid.financials.AccountHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getAccountHierarchyId | ||
| Description |
Gets the hierarchy | ||
| 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 | |
| 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 | ||
| 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 |
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 |
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. | |