Interface StockWarehouseSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StockWarehouseSession
extends OsidSession

This session provides methods to retrieve Stock to Warehouse mappings. A Stock may appear in multiple Warehouse objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupStockWarehouseMappings()	Tests if this user can perform lookups of stock/warehouse mappings.
IdList	getStockIdsByWarehouse(Id warehouseId)	Gets the list of Stock Ids associated with a Warehouse .
IdList	getStockIdsByWarehouses(IdList warehouseIds)	Gets the list of Stock Ids corresponding to a list of Warehouse objects.
StockList	getStocksByWarehouse(Id warehouseId)	Gets the list of Stocks associated with a Warehouse .
StockList	getStocksByWarehouses(IdList warehouseIds)	Gets the list of Stocks corresponding to a list of Warehouse objects.
IdList	getWarehouseIdsByStock(Id stockId)	Gets the Warehouse Ids mapped to a Stock .
WarehouseList	getWarehousesByStock(Id stockId)	Gets the Warehouse objects mapped to a Stock .
void	useComparativeStockWarehouseView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryStockWarehouseView()	A complete view of the Stock and Warehouse 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

canLookupStockWarehouseMappings

boolean canLookupStockWarehouseMappings()

Tests if this user can perform lookups of stock/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStockWarehouseView

void useComparativeStockWarehouseView()

The returns from the lookup 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.

usePlenaryStockWarehouseView

void usePlenaryStockWarehouseView()

A complete view of the Stock and Warehouse 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.

getStockIdsByWarehouse

IdList getStockIdsByWarehouse(Id warehouseId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Stock Ids associated with a Warehouse .

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related stock Ids

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocksByWarehouse

StockList getStocksByWarehouse(Id warehouseId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Stocks associated with a Warehouse .

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related stocks

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStockIdsByWarehouses

IdList getStockIdsByWarehouses(IdList warehouseIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Stock Ids corresponding to a list of Warehouse objects.

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of stock Ids

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocksByWarehouses

StockList getStocksByWarehouses(IdList warehouseIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Stocks corresponding to a list of Warehouse objects.

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of stocks

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehouseIdsByStock

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

Gets the Warehouse Ids mapped to a Stock .

Parameters:

stockId - Id of a Stock

Returns:

list of warehouses

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.

getWarehousesByStock

WarehouseList getWarehousesByStock(Id stockId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Warehouse objects mapped to a Stock .

Parameters:

stockId - Id of a Stock

Returns:

list of warehouses

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.