Interface BillingHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBillingHierarchyId

Id getBillingHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBillingHierarchy

Hierarchy getBillingHierarchy()
                       throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyBillingHierarchy

boolean canModifyBillingHierarchy()

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.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootBilling

void addRootBilling(Id billingId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root billing.

Parameters:

billingId - the Id of a billing

Throws:

AlreadyExistsException - billingId is already in hierarchy

NotFoundException - billingId is not found

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootBilling

void removeRootBilling(Id billingId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root billing.

Parameters:

billingId - the Id of a billing

Throws:

NotFoundException - billingId is not found

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildBilling

void addChildBilling(Id billingId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a billing.

Parameters:

billingId - the Id of a billing

childId - the Id of the new child

Throws:

AlreadyExistsException - billingId is already a parent of childId

NotFoundException - billingId or childId not found

NullArgumentException - billingId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBilling

void removeChildBilling(Id billingId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a billing.

Parameters:

billingId - the Id of a billing

childId - the Id of the new child

Throws:

NotFoundException - billingId not a parent of childId

NullArgumentException - billingId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBillings

void removeChildBillings(Id billingId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a billing.

Parameters:

billingId - the Id of a billing

Throws:

NotFoundException - billingId is not found

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.