Interface | osid.acknowledgement.BillingHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
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 This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | canAccessBillingHierarchy | ||
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 | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeBillingView | ||
Description |
The returns from the billing 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 | usePlenaryBillingView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootBillingIds | ||
Description |
Gets the root billing | ||
Return | osid.id.IdList | the root billing Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootBillings | ||
Description |
Gets the root billings in the billing hierarchy. A node
with no parents is an orphan. While all billing | ||
Return | osid.acknowledgement.BillingList | the root billings | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentBillings | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | billingId | a billing Id |
Return | boolean | true if the billing has parents, f alse
otherwise | |
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 | isParentOfBilling | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | billingId | the Id of a billing | |
Return | boolean | true if this id is a parent of
billingId, f alse otherwise | |
Errors | NOT_FOUND | billingId is not found | |
NULL_ARGUMENT | id or billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentBillingIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | billingId | a billing Id |
Return | osid.id.IdList | the parent Ids of the 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 | getParentBillings | ||
Description |
Gets the parent billings of the given | ||
Parameters | osid.id.Id | billingId | the Id of the Billing to query |
Return | osid.acknowledgement.BillingList | the parent billings of the id | |
Errors | NOT_FOUND | a Billing identified by Id 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 | isAncestorOfBilling | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | billingId | the Id of a billing | |
Return | boolean | tru e if this id is an ancestor of
billingId, false otherwise | |
Errors | NOT_FOUND | billingId is not found | |
NULL_ARGUMENT | id or billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildBillings | ||
Description |
Tests if a billing has any children. | ||
Parameters | osid.id.Id | billingId | a billing Id |
Return | boolean | true if the billingId has children,
false otherwise | |
Errors | NOT_FOUND | billingId is not found | |
NULL_ARGUMENT | bobillingId is null okId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfBilling | ||
Description |
Tests if a billing is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | billingId | the Id of a billing | |
Return | boolean | true if the id is a child of
billingId, false otherwise | |
Errors | NOT_FOUND | billingId is not found | |
NULL_ARGUMENT | id or billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildBillingIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | billingId | the Id to query |
Return | osid.id.IdList | the children of the 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 | getChildBillings | ||
Description |
Gets the child billings of the given | ||
Parameters | osid.id.Id | billingId | the Id of the Billing to query |
Return | osid.acknowledgement.BillingList | the child billings of the id | |
Errors | NOT_FOUND | a Billing identified by Id 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 | isDescendantOfBilling | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | billingId | the Id of a billing | |
Return | boolean | true if the id is a descendant of the
billingId, false otherwise | |
Errors | NOT_FOUND | billingId is not found | |
NULL_ARGUMENT | id or billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getBillingNodeIds | ||
Description |
Gets a portion of the hierarchy for the given billing. | ||
Parameters | osid.id.Id | billingId | 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 | a billing node | |
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 | getBillingNodes | ||
Description |
Gets a portion of the hierarchy for the given billing. | ||
Parameters | osid.id.Id | billingId | 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.acknowledgement.BillingNode | a billing node | |
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. |