Interface BusinessHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BusinessHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildBusiness(Id businessId, Id childId)	Adds a child to a business.
void	addRootBusiness(Id businessId)	Adds a root customer ecatalog.
boolean	canModifyBusinessHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getBusinessHierarchy()	Gets the hierarchy associated with this session.
Id	getBusinessHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildBusiness(Id businessId, Id childId)	Removes a child from a business.
void	removeChildBusinesses(Id businessId)	Removes all children from a business.
void	removeRootBusiness(Id businessId)	Removes a root customer ecatalog.

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.

canModifyBusinessHierarchy

boolean canModifyBusinessHierarchy()

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.

addRootBusiness

void addRootBusiness(Id businessId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root customer ecatalog.

Parameters:

businessId - the Id of a business

Throws:

AlreadyExistsException - businessId is already in hierarchy

NotFoundException - businessId not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootBusiness

void removeRootBusiness(Id businessId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root customer ecatalog.

Parameters:

businessId - the Id of a business

Throws:

NotFoundException - businessId not a root

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildBusiness

void addChildBusiness(Id businessId,
 Id childId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a business.

Parameters:

businessId - the Id of a business

childId - the Id of the new child

Throws:

AlreadyExistsException - businessId is already a parent of childId

NotFoundException - businessId or childId not found

NullArgumentException - businessId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBusiness

void removeChildBusiness(Id businessId,
 Id childId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a business.

Parameters:

businessId - the Id of a business

childId - the Id of the new child

Throws:

NotFoundException - businessId is not a parent of childId

NullArgumentException - businessId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBusinesses

void removeChildBusinesses(Id businessId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a business.

Parameters:

businessId - the Id of a business

Throws:

NotFoundException - businessId is in hierarchy

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.