Interface StockHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StockHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Stocks . Each node in the hierarchy is a unique Stock . The hierarchy may be traversed recursively to establish the tree structure through getParentStocks() and getChildStocks() . To relate these Ids to another OSID, getStockNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Stock available in the Inventory OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentStocks() or getChildStocks() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: stock elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessStockHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildStockIds(Id stockId)	Gets the child Ids of the given stock.
StockList	getChildStocks(Id stockId)	Gets the children of the given stock.
IdList	getParentStockIds(Id stockId)	Gets the parent Ids of the given stock.
StockList	getParentStocks(Id stockId)	Gets the parents of the given stock.
IdList	getRootStockIds()	Gets the root stock Ids in this hierarchy.
StockList	getRootStocks()	Gets the root stocks in the stock hierarchy.
Hierarchy	getStockHierarchy()	Gets the hierarchy associated with this session.
Id	getStockHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getStockNodeIds(Id stockId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given stock.
StockNode	getStockNodes(Id stockId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given stock.
boolean	hasChildStocks(Id stockId)	Tests if a stock has any children.
boolean	hasParentStocks(Id stockId)	Tests if the Stock has any parents.
boolean	isAncestorOfStock(Id id, Id stockId)	Tests if an Id is an ancestor of a stock.
boolean	isChildOfStock(Id id, Id stockId)	Tests if a stock is a direct child of another.
boolean	isDescendantOfStock(Id id, Id stockId)	Tests if an Id is a descendant of a stock.
boolean	isParentOfStock(Id id, Id stockId)	Tests if an Id is a direct parent of stock.
void	useComparativeStockView()	The returns from the stock methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryStockView()	A complete view of the Stocks returns is desired.

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.

canAccessStockHierarchy

boolean canAccessStockHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStockView

void useComparativeStockView()

The returns from the stock methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryStockView

void usePlenaryStockView()

A complete view of the Stocks returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootStockIds

IdList getRootStockIds()
                throws OperationFailedException,
PermissionDeniedException

Gets the root stock Ids in this hierarchy.

Returns:

the root stock Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootStocks

StockList getRootStocks()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root stocks in the stock hierarchy. A node with no parents is an orphan. While all stock Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root stocks

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentStocks

boolean hasParentStocks(Id stockId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Stock has any parents.

Parameters:

stockId - a stock Id

Returns:

true if the stock has parents, f alse otherwise

Throws:

NotFoundException - stockId is not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfStock

boolean isParentOfStock(Id id,
 Id stockId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of stock.

Parameters:

id - an Id

stockId - the Id of a stock

Returns:

true if this id is a parent of stockId , f alse otherwise

Throws:

NotFoundException - stockId is not found

NullArgumentException - id or stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentStockIds

IdList getParentStockIds(Id stockId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given stock.

Parameters:

stockId - a stock Id

Returns:

the parent Ids of the stock

Throws:

NotFoundException - stockId is not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentStocks

StockList getParentStocks(Id stockId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given stock.

Parameters:

stockId - the Id to query

Returns:

the parents of the stock

Throws:

NotFoundException - stockId not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfStock

boolean isAncestorOfStock(Id id,
 Id stockId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a stock.

Parameters:

id - an Id

stockId - the Id of a stock

Returns:

true if this id is an ancestor of stockId , false otherwise

Throws:

NotFoundException - stockId not found

NullArgumentException - stockId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildStocks

boolean hasChildStocks(Id stockId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a stock has any children.

Parameters:

stockId - a stock Id

Returns:

true if the stockId has children, false otherwise

Throws:

NotFoundException - stockId not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfStock

boolean isChildOfStock(Id id,
 Id stockId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a stock is a direct child of another.

Parameters:

id - an Id

stockId - the Id of a stock

Returns:

true if the id is a child of stockId , false otherwise

Throws:

NotFoundException - stockId not found

NullArgumentException - id or stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildStockIds

IdList getChildStockIds(Id stockId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given stock.

Parameters:

stockId - the Id to query

Returns:

the children of the stock

Throws:

NotFoundException - stockId not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildStocks

StockList getChildStocks(Id stockId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given stock.

Parameters:

stockId - the Id to query

Returns:

the children of the stock

Throws:

NotFoundException - stockId not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfStock

boolean isDescendantOfStock(Id id,
 Id stockId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a stock.

Parameters:

id - an Id

stockId - the Id of a stock

Returns:

true if the id is a descendant of the stockId , false otherwise

Throws:

NotFoundException - stockId not found

NullArgumentException - id or stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getStockNodeIds

Node getStockNodeIds(Id stockId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given stock.

Parameters:

stockId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a stock node

Throws:

NotFoundException - stockId not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStockNodes

StockNode getStockNodes(Id stockId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given stock.

Parameters:

stockId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a stock node

Throws:

NotFoundException - stockId not found

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.