public interface BillingHierarchyDesignSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
addChildBilling(Id billingId,
Id childId)
Adds a child to a billing.
|
void |
addRootBilling(Id billingId)
Adds a root billing.
|
boolean |
canModifyBillingHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getBillingHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getBillingHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildBilling(Id billingId,
Id childId)
Removes a child from a billing.
|
void |
removeChildBillings(Id billingId)
Removes all children from a billing.
|
void |
removeRootBilling(Id billingId)
Removes a root billing.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBillingHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getBillingHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyBillingHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootBilling(Id billingId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
billingId
- the Id
of a billingAlreadyExistsException
- billingId
is
already in hierarchyNotFoundException
- billingId
is not
foundNullArgumentException
- billingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootBilling(Id billingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
billingId
- the Id
of a billingNotFoundException
- billingId
is not
foundNullArgumentException
- billingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildBilling(Id billingId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
billingId
- the Id
of a billingchildId
- the Id
of the new childAlreadyExistsException
- billingId
is
already a parent of childId
NotFoundException
- billingId
or
childId
not foundNullArgumentException
- billingId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBilling(Id billingId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
billingId
- the Id
of a billingchildId
- the Id
of the new childNotFoundException
- billingId
not a
parent of childId
NullArgumentException
- billingId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBillings(Id billingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
billingId
- the Id
of a billingNotFoundException
- billingId
is not
foundNullArgumentException
- billingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.