Interface BillingHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BillingHierarchySession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessBillingHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getBillingHierarchy()	Gets the hierarchy associated with this session.
Id	getBillingHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getBillingNodeIds(Id billingId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given billing.
BillingNode	getBillingNodes(Id billingId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given billing.
IdList	getChildBillingIds(Id billingId)	Gets the child Ids of the given billing.
BillingList	getChildBillings(Id billingId)	Gets the child billings of the given id .
IdList	getParentBillingIds(Id billingId)	Gets the parent Ids of the given billing.
BillingList	getParentBillings(Id billingId)	Gets the parent billings of the given id .
IdList	getRootBillingIds()	Gets the root billing Ids in this hierarchy.
BillingList	getRootBillings()	Gets the root billings in the billing hierarchy.
boolean	hasChildBillings(Id billingId)	Tests if a billing has any children.
boolean	hasParentBillings(Id billingId)	Tests if the Billing has any parents.
boolean	isAncestorOfBilling(Id id, Id billingId)	Tests if an Id is an ancestor of a billing.
boolean	isChildOfBilling(Id id, Id billingId)	Tests if a billing is a direct child of another.
boolean	isDescendantOfBilling(Id id, Id billingId)	Tests if an Id is a descendant of a billing.
boolean	isParentOfBilling(Id id, Id billingId)	Tests if an Id is a direct parent of billing.
void	useComparativeBillingView()	The returns from the billing methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBillingView()	A complete view of the Billing returns is desired.

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.

canAccessBillingHierarchy

boolean canAccessBillingHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBillingView

void useComparativeBillingView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryBillingView

void usePlenaryBillingView()

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.

Compliance:

mandatory - This method is must be implemented.

getRootBillingIds

IdList getRootBillingIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root billing Ids in this hierarchy.

Returns:

the root billing Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootBillings

BillingList getRootBillings()
                     throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root billings

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentBillings

boolean hasParentBillings(Id billingId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Billing has any parents.

Parameters:

billingId - a billing Id

Returns:

true if the billing has parents, f alse otherwise

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.

isParentOfBilling

boolean isParentOfBilling(Id id,
 Id billingId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of billing.

Parameters:

id - an Id

billingId - the Id of a billing

Returns:

true if this id is a parent of billingId , f alse otherwise

Throws:

NotFoundException - billingId is not found

NullArgumentException - id or billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentBillingIds

IdList getParentBillingIds(Id billingId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given billing.

Parameters:

billingId - a billing Id

Returns:

the parent Ids of the 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.

getParentBillings

BillingList getParentBillings(Id billingId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent billings of the given id .

Parameters:

billingId - the Id of the Billing to query

Returns:

the parent billings of the id

Throws:

NotFoundException - a Billing identified by Id is not found

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfBilling

boolean isAncestorOfBilling(Id id,
 Id billingId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a billing.

Parameters:

id - an Id

billingId - the Id of a billing

Returns:

true if this id is an ancestor of billingId , false otherwise

Throws:

NotFoundException - billingId is not found

NullArgumentException - id or billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildBillings

boolean hasChildBillings(Id billingId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a billing has any children.

Parameters:

billingId - a billing Id

Returns:

true if the billingId has children, false otherwise

Throws:

NotFoundException - billingId is not found

NullArgumentException - bobillingId is null okId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfBilling

boolean isChildOfBilling(Id id,
 Id billingId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a billing is a direct child of another.

Parameters:

id - an Id

billingId - the Id of a billing

Returns:

true if the id is a child of billingId , false otherwise

Throws:

NotFoundException - billingId is not found

NullArgumentException - id or billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildBillingIds

IdList getChildBillingIds(Id billingId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given billing.

Parameters:

billingId - the Id to query

Returns:

the children of the 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.

getChildBillings

BillingList getChildBillings(Id billingId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child billings of the given id .

Parameters:

billingId - the Id of the Billing to query

Returns:

the child billings of the id

Throws:

NotFoundException - a Billing identified by Id is not found

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfBilling

boolean isDescendantOfBilling(Id id,
 Id billingId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a billing.

Parameters:

id - an Id

billingId - the Id of a billing

Returns:

true if the id is a descendant of the billingId , false otherwise

Throws:

NotFoundException - billingId is not found

NullArgumentException - id or billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getBillingNodeIds

Node getBillingNodeIds(Id billingId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given billing.

Parameters:

billingId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a billing node

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.

getBillingNodes

BillingNode getBillingNodes(Id billingId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given billing.

Parameters:

billingId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a billing node

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.