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.

Like all OsidSessions, BusinessHierarchyDesignSessions are dedicated to single processing threads and a single authenticated user.

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 Business.
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 Business.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

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 Business.

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 Business.

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.