Interface StockHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StockHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildStock(Id stockId, Id childId)	Adds a child to a stock.
void	addRootStock(Id stockId)	Adds a root stock.
boolean	canModifyStockHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getStockHierarchy()	Gets the hierarchy associated with this session.
Id	getStockHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildStock(Id stockId, Id childId)	Removes a child from a stock.
void	removeChildStocks(Id stockId)	Removes all children from a stock.
void	removeRootStock(Id stockId)	Removes a stock.

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

getStockHierarchyId

Id getStockHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getStockHierarchy

Hierarchy getStockHierarchy()
                     throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the stock hierarchy

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyStockHierarchy

boolean canModifyStockHierarchy()

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.

addRootStock

void addRootStock(Id stockId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root stock.

Parameters:

stockId - the Id of a stock

Throws:

AlreadyExistsException - stockId is already in hierarchy

NotFoundException - stockId not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootStock

void removeRootStock(Id stockId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a stock.

Parameters:

stockId - the Id of a stock

Throws:

NotFoundException - stockId not a root

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildStock

void addChildStock(Id stockId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a stock.

Parameters:

stockId - the Id of a stock

childId - the Id of the new child

Throws:

AlreadyExistsException - stockId is already a parent of childId

NotFoundException - stockId or childId not found

NullArgumentException - stockId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildStock

void removeChildStock(Id stockId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a stock.

Parameters:

stockId - the Id of a stock

childId - the Id of the new child

Throws:

NotFoundException - stockId is not a parent of childId

NullArgumentException - stockId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildStocks

void removeChildStocks(Id stockId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a stock.

Parameters:

stockId - the Id of a stock

Throws:

NotFoundException - stockId is in hierarchy

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.