Interface WarehouseHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface WarehouseHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildWarehouse(Id warehouseId, Id childId)	Adds a child to a warehouse.
void	addRootWarehouse(Id warehouseId)	Adds a root warehouse.
boolean	canModifyWarehouseHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getWarehouseHierarchy()	Gets the hierarchy associated with this session.
Id	getWarehouseHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildWarehouse(Id warehouseId, Id childId)	Removes a child from a warehouse.
void	removeChildWarehouses(Id warehouseId)	Removes all children from a warehouse.
void	removeRootWarehouse(Id warehouseId)	Removes a warehouse.

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

getWarehouseHierarchyId

Id getWarehouseHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getWarehouseHierarchy

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

canModifyWarehouseHierarchy

boolean canModifyWarehouseHierarchy()

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.

addRootWarehouse

void addRootWarehouse(Id warehouseId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root warehouse.

Parameters:

warehouseId - the Id of a warehouse

Throws:

AlreadyExistsException - warehouseId is already in hierarchy

NotFoundException - warehouseId not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootWarehouse

void removeRootWarehouse(Id warehouseId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a warehouse.

Parameters:

warehouseId - the Id of a warehouse

Throws:

NotFoundException - warehouseId not a root

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildWarehouse

void addChildWarehouse(Id warehouseId,
 Id childId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a warehouse.

Parameters:

warehouseId - the Id of a warehouse

childId - the Id of the new child

Throws:

AlreadyExistsException - warehouseId is already a parent of childId

NotFoundException - warehouseId or childId not found

NullArgumentException - warehouseId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildWarehouse

void removeChildWarehouse(Id warehouseId,
 Id childId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a warehouse.

Parameters:

warehouseId - the Id of a warehouse

childId - the Id of the new child

Throws:

NotFoundException - warehouseId is not a parent of childId

NullArgumentException - warehouseId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildWarehouses

void removeChildWarehouses(Id warehouseId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a warehouse.

Parameters:

warehouseId - the Id of a warehouse

Throws:

NotFoundException - warehouseId is in hierarchy

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.