OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.BusinessHierarchyDesignSession
Implementsosid.OsidSession
Description

This session defines methods for managing a hierarchy of Business objects. Each node in the hierarchy is a unique Business.

MethodgetBusinessHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusinessHierarchy
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.
MethodcanModifyBusinessHierarchy
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.
MethodaddRootBusiness
Description

Adds a root customer ecatalog.

Parametersosid.id.IdbusinessIdthe Id of a business
ErrorsALREADY_EXISTS businessId is already in hierarchy
NOT_FOUND businessId not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootBusiness
Description

Removes a root customer ecatalog.

Parametersosid.id.IdbusinessIdthe Id of a business
ErrorsNOT_FOUND businessId not a root
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildBusiness
Description

Adds a child to a business.

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

Removes a child from a business.

Parametersosid.id.IdbusinessIdthe Id of a business
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND businessId is not a parent of childId
NULL_ARGUMENT businessId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBusinesses
Description

Removes all children from a business.

Parametersosid.id.IdbusinessIdthe Id of a business
ErrorsNOT_FOUND businessId is in hierarchy
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.