Interface DepotHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DepotHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildDepot(Id depotId, Id childId)	Adds a child to a depot.
void	addRootDepot(Id depotId)	Adds a root depot.
boolean	canModifyDepotHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getDepotHierarchy()	Gets the hierarchy associated with this session.
Id	getDepotHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildDepot(Id depotId, Id childId)	Removes a child from a depot.
void	removeChildDepots(Id depotId)	Removes all children from a depot.
void	removeRootDepot(Id depotId)	Removes a root depot.

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

getDepotHierarchyId

Id getDepotHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDepotHierarchy

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

canModifyDepotHierarchy

boolean canModifyDepotHierarchy()

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.

addRootDepot

void addRootDepot(Id depotId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root depot.

Parameters:

depotId - the Id of a depot

Throws:

AlreadyExistsException - depotId is already in hierarchy

NotFoundException - depotId not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootDepot

void removeRootDepot(Id depotId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root depot.

Parameters:

depotId - the Id of a depot

Throws:

NotFoundException - depotId is not a root

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildDepot

void addChildDepot(Id depotId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a depot.

Parameters:

depotId - the Id of a depot

childId - the Id of the new child

Throws:

AlreadyExistsException - depotId is already a parent of childId

NotFoundException - depotId or childId not found

NullArgumentException - depotId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildDepot

void removeChildDepot(Id depotId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a depot.

Parameters:

depotId - the Id of a depot

childId - the Id of the new child

Throws:

NotFoundException - depotId not a parent of childId

NullArgumentException - depotId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildDepots

void removeChildDepots(Id depotId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a depot.

Parameters:

depotId - the Id of a depot

Throws:

NotFoundException - depotId not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.