OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.BillingHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Billing objects. Each node in the hierarchy is a unique Billing. The hierarchy may be traversed recursively to establish the tree structure through getParentBillings() and getChildBillings(). To relate these Ids to another OSID, getBillingNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Billing available in the Acknowledgement OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

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 getParentBillings() or getChildBillings() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: billing elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodgetBillingHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBillingHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessBillingHierarchy
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBillingView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBillingView
Description

A complete view of the Billing returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetRootBillingIds
Description

Gets the root billing Ids in this hierarchy.

Returnosid.id.IdListthe root billing Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootBillings
Description

Gets the root billings in the billing hierarchy. A node with no parents is an orphan. While all billing Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returnosid.acknowledgement.BillingListthe root billings
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentBillings
Description

Tests if the Billing has any parents.

Parametersosid.id.IdbillingIda billing Id
Returnboolean true if the billing has parents, f alse otherwise
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfBilling
Description

Tests if an Id is a direct parent of billing.

Parametersosid.id.Ididan Id
osid.id.IdbillingIdthe Id of a billing
Returnboolean true if this id is a parent of billingId, f alse otherwise
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT id or billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentBillingIds
Description

Gets the parent Ids of the given billing.

Parametersosid.id.IdbillingIda billing Id
Returnosid.id.IdListthe parent Ids of the billing
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentBillings
Description

Gets the parent billings of the given id.

Parametersosid.id.IdbillingIdthe Id of the Billing to query
Returnosid.acknowledgement.BillingListthe parent billings of the id
ErrorsNOT_FOUNDa Billing identified by Id is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfBilling
Description

Tests if an Id is an ancestor of a billing.

Parametersosid.id.Ididan Id
osid.id.IdbillingIdthe Id of a billing
Returnboolean tru e if this id is an ancestor of billingId, false otherwise
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT id or billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildBillings
Description

Tests if a billing has any children.

Parametersosid.id.IdbillingIda billing Id
Returnboolean true if the billingId has children, false otherwise
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT bobillingId is null okId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfBilling
Description

Tests if a billing is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdbillingIdthe Id of a billing
Returnboolean true if the id is a child of billingId, false otherwise
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT id or billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildBillingIds
Description

Gets the child Ids of the given billing.

Parametersosid.id.IdbillingIdthe Id to query
Returnosid.id.IdListthe children of the billing
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildBillings
Description

Gets the child billings of the given id.

Parametersosid.id.IdbillingIdthe Id of the Billing to query
Returnosid.acknowledgement.BillingListthe child billings of the id
ErrorsNOT_FOUNDa Billing identified by Id is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfBilling
Description

Tests if an Id is a descendant of a billing.

Parametersosid.id.Ididan Id
osid.id.IdbillingIdthe Id of a billing
Returnboolean true if the id is a descendant of the billingId, false otherwise
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT id or billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetBillingNodeIds
Description

Gets a portion of the hierarchy for the given billing.

Parametersosid.id.IdbillingIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea billing node
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBillingNodes
Description

Gets a portion of the hierarchy for the given billing.

Parametersosid.id.IdbillingIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.acknowledgement.BillingNodea billing node
ErrorsNOT_FOUND billingId is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.