Interface | osid.acknowledgement.BillingHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages a hierarchy of billings. Billings may
be organized into a hierarchy for organizing or federating. A
parent | ||
Method | getBillingHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBillingHierarchy | ||
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 | canModifyBillingHierarchy | ||
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 | addRootBilling | ||
Description |
Adds a root billing. | ||
Parameters | osid.id.Id | billingId | the Id of a billing |
Errors | ALREADY_EXISTS | billingId is already in hierarchy | |
NOT_FOUND | billingId is not found | ||
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootBilling | ||
Description |
Removes a root billing. | ||
Parameters | osid.id.Id | billingId | the Id of a billing |
Errors | NOT_FOUND | billingId is not found | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildBilling | ||
Description |
Adds a child to a billing. | ||
Parameters | osid.id.Id | billingId | the Id of a billing |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | billingId is already a parent of childId | |
NOT_FOUND | billingId or childId not found | ||
NULL_ARGUMENT | billingId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildBilling | ||
Description |
Removes a child from a billing. | ||
Parameters | osid.id.Id | billingId | the Id of a billing |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | billingId not a parent of childId | |
NULL_ARGUMENT | billingId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildBillings | ||
Description |
Removes all children from a billing. | ||
Parameters | osid.id.Id | billingId | the Id of a billing |
Errors | NOT_FOUND | billingId is not found | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |