Interface DistributorHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DistributorHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildDistributor(Id distributorId, Id childId)	Adds a child to a distributor.
void	addRootDistributor(Id distributorId)	Adds a root distributor.
boolean	canModifyDistributorHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getDistributorHierarchy()	Gets the hierarchy associated with this session.
Id	getDistributorHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildDistributor(Id distributorId, Id childId)	Removes a child from a distributor.
void	removeChildDistributors(Id distributorId)	Removes all children from a distributor.
void	removeRootDistributor(Id distributorId)	Removes a root distributor.

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

getDistributorHierarchyId

Id getDistributorHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributorHierarchy

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

canModifyDistributorHierarchy

boolean canModifyDistributorHierarchy()

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.

addRootDistributor

void addRootDistributor(Id distributorId)
                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root distributor.

Parameters:

distributorId - the Id of a distributor

Throws:

AlreadyExistsException - distributorId is already in hierarchy

NotFoundException - distributorId not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootDistributor

void removeRootDistributor(Id distributorId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root distributor.

Parameters:

distributorId - the Id of a distributor

Throws:

NotFoundException - distributorId is not a root

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildDistributor

void addChildDistributor(Id distributorId,
 Id childId)
                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a distributor.

Parameters:

distributorId - the Id of a distributor

childId - the Id of the new child

Throws:

AlreadyExistsException - distributorId is already a parent of childId

NotFoundException - distributorId or childId not found

NullArgumentException - distributorId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildDistributor

void removeChildDistributor(Id distributorId,
 Id childId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a distributor.

Parameters:

distributorId - the Id of a distributor

childId - the Id of the new child

Throws:

NotFoundException - distributorId is not parent of childId

NullArgumentException - distributorId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildDistributors

void removeChildDistributors(Id distributorId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a distributor.

Parameters:

distributorId - the Id of a distributor

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.