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

This session manages a hierarchy of billings. Billings may be organized into a hierarchy for organizing or federating. A parent Billing includes all of the credits of its children such that a single root node contains all of the credits of the federation.

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.
MethodcanModifyBillingHierarchy
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootBilling
Description

Adds a root billing.

Parametersosid.id.IdbillingIdthe Id of a billing
ErrorsALREADY_EXISTS billingId is already in hierarchy
NOT_FOUND billingId is not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootBilling
Description

Removes a root billing.

Parametersosid.id.IdbillingIdthe Id of a 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.
MethodaddChildBilling
Description

Adds a child to a billing.

Parametersosid.id.IdbillingIdthe Id of a billing
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS billingId is already a parent of childId
NOT_FOUND billingId or childId not found
NULL_ARGUMENT billingId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBilling
Description

Removes a child from a billing.

Parametersosid.id.IdbillingIdthe Id of a billing
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND billingId not a parent of childId
NULL_ARGUMENT billingId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBillings
Description

Removes all children from a billing.

Parametersosid.id.IdbillingIdthe Id of a 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.