OSID Specifications
billing package
Version 3.0.0
billing package
Version 3.0.0
| Interface | osid.billing.BusinessHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.billing.BillingManager | ||
osid.billing.BillingProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getBusinessHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusinessHierarchy | ||
| 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 | canModifyBusinessHierarchy | ||
| 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 | addRootBusiness | ||
| Description |
Adds a root customer ecatalog. | ||
| Parameters | osid.id.Id | businessId | the Id of a business |
| Errors | ALREADY_EXISTS | businessId is already in hierarchy | |
| NOT_FOUND | businessId not found | ||
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootBusiness | ||
| Description |
Removes a root customer ecatalog. | ||
| Parameters | osid.id.Id | businessId | the Id of a business |
| Errors | NOT_FOUND | businessId not a root | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildBusiness | ||
| Description |
Adds a child to a business. | ||
| Parameters | osid.id.Id | businessId | the Id of a business |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | businessId is already a parent of childId | |
| NOT_FOUND | businessId or childId not found | ||
| NULL_ARGUMENT | businessId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildBusiness | ||
| Description |
Removes a child from a business. | ||
| Parameters | osid.id.Id | businessId | the Id of a business |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | businessId is not a parent of childId | |
| NULL_ARGUMENT | businessId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildBusinesses | ||
| Description |
Removes all children from a business. | ||
| Parameters | osid.id.Id | businessId | the Id of a business |
| Errors | NOT_FOUND | businessId is in hierarchy | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |