Interface BusinessHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BusinessHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Businesses . Each node in the hierarchy is a unique Business . The hierarchy may be traversed recursively to establish the tree structure through getParentBusinesses() and getChildBusinesses() . To relate these Ids to another OSID, getBusinessNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Business available in the Financials 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 getParentBusinesses() or getChildBusiness() 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: repository 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	canAccessBusinessHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getBusinessHierarchy()	Gets the hierarchy associated with this session.
Id	getBusinessHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getBusinessNodeIds(Id businessId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given business.
BusinessNode	getBusinessNodes(Id businessId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given business.
BusinessList	getChildBusinesses(Id businessId)	Gets the children of the given business.
IdList	getChildBusinessIds(Id businessId)	Gets the child Ids of the given business.
BusinessList	getParentBusinesses(Id businessId)	Gets the parents of the given business.
IdList	getParentBusinessIds(Id businessId)	Gets the parent Ids of the given business.
BusinessList	getRootBusinesses()	Gets the root businesses in the business hierarchy.
IdList	getRootBusinessIds()	Gets the root business Ids in this hierarchy.
boolean	hasChildBusinesses(Id businessId)	Tests if a business has any children.
boolean	hasParentBusinesses(Id businessId)	Tests if the Business has any parents.
boolean	isAncestorOfBusiness(Id id, Id businessId)	Tests if an Id is an ancestor of a business.
boolean	isChildOfBusiness(Id id, Id businessId)	Tests if a business is a direct child of another.
boolean	isDescendantOfBusiness(Id id, Id businessId)	Tests if an Id is a descendant of a business.
boolean	isParentOfBusiness(Id id, Id businessId)	Tests if an Id is a direct parent of business.
void	useComparativeBusinessView()	The returns from the business methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBusinessView()	A complete view of the Businesses 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

getBusinessHierarchyId

Id getBusinessHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusinessHierarchy

Hierarchy getBusinessHierarchy()
                        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.

canAccessBusinessHierarchy

boolean canAccessBusinessHierarchy()

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.

useComparativeBusinessView

void useComparativeBusinessView()

The returns from the business 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.

usePlenaryBusinessView

void usePlenaryBusinessView()

A complete view of the Businesses 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.

getRootBusinessIds

IdList getRootBusinessIds()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root business Ids in this hierarchy.

Returns:

the root catalog Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootBusinesses

BusinessList getRootBusinesses()
                        throws OperationFailedException,
PermissionDeniedException

Gets the root businesses in the business hierarchy. A node with no parents is an orphan. While all business 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 businesses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentBusinesses

boolean hasParentBusinesses(Id businessId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Business has any parents.

Parameters:

businessId - a catalog Id

Returns:

true if the catalog has parents, f alse otherwise

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfBusiness

boolean isParentOfBusiness(Id id,
 Id businessId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of business.

Parameters:

id - an Id

businessId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - businessId is not found

NullArgumentException - id or businessId 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} .

getParentBusinessIds

IdList getParentBusinessIds(Id businessId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given business.

Parameters:

businessId - a catalog Id

Returns:

the parent Ids of the catalog

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentBusinesses

BusinessList getParentBusinesses(Id businessId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given business.

Parameters:

businessId - the Id to query

Returns:

the parents of the business

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfBusiness

boolean isAncestorOfBusiness(Id id,
 Id businessId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a business.

Parameters:

id - an Id

businessId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId or id 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} .

hasChildBusinesses

boolean hasChildBusinesses(Id businessId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a business has any children.

Parameters:

businessId - a business Id

Returns:

true if the businessId has children, false otherwise

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfBusiness

boolean isChildOfBusiness(Id id,
 Id businessId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a business is a direct child of another.

Parameters:

id - an Id

businessId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - businessId not found

NullArgumentException - id or businessId 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} .

getChildBusinessIds

IdList getChildBusinessIds(Id businessId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given business.

Parameters:

businessId - the Id to query

Returns:

the children of the catalog

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildBusinesses

BusinessList getChildBusinesses(Id businessId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given business.

Parameters:

businessId - the Id to query

Returns:

the children of the business

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfBusiness

boolean isDescendantOfBusiness(Id id,
 Id businessId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a business.

Parameters:

id - an Id

businessId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - businessId not found

NullArgumentException - id or businessId 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} .

getBusinessNodeIds

Node getBusinessNodeIds(Id businessId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given business.

Parameters:

businessId - 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 catalog node

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessNodes

BusinessNode getBusinessNodes(Id businessId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given business.

Parameters:

businessId - 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 catalog node

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.