org.osid.inventory

Interface StockLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface StockLookupSession
extends OsidSession

This session defines methods for retrieving stocks.

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
• isolated warehouse view: All stock methods in this session operate, retrieve and pertain to stocks defined explicitly in the current warehouse. Using an isolated view is useful for managing Stocks with the StockAdminSession.
• federated warehouse view: All stock lookup methods in this session operate, retrieve and pertain to all stocks defined in this warehouse and any other stocks implicitly available in this warehouse through warehouse inheritence.

The methods useFederatedWarehouseView() and useIsolatedWarehouseView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupStocks() Tests if this user can perform Stock lookups.
Stock	getStock(Id stockId) Gets the Stock specified by its Id.
StockList	getStocks() Gets all Stocks.
StockList	getStocksByGenusType(Type stockGenusType) Gets a StockList corresponding to the given stock genus Type which does not include stocks of types derived from the specified Type.
StockList	getStocksByIds(IdList stockIds) Gets a StockList corresponding to the given IdList.
StockList	getStocksByParentGenusType(Type stockGenusType) Gets a StockList corresponding to the given stock genus Type and include any additional stocks with genus types derived from the specified Type.
StockList	getStocksByRecordType(Type stockRecordType) Gets a StockList containing the given stock record Type.
StockList	getStocksBySKU(java.lang.String sku) Gets a StockList containing for the given SKU.
Warehouse	getWarehouse() Gets the Warehouse associated with this session.
Id	getWarehouseId() Gets the Warehouse Id associated with this session.
void	useComparativeStockView() 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	useFederatedWarehouseView() Federates the view for methods in this session.
void	useIsolatedWarehouseView() Isolates the view for methods in this session.
void	usePlenaryStockView() A complete view of the Stock returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getWarehouseId

Id getWarehouseId()

Gets the Warehouse Id associated with this session.

Returns:

the Warehouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getWarehouse

Warehouse getWarehouse()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Warehouse associated with this session.

Returns:

the warehouse

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupStocks

boolean canLookupStocks()

Tests if this user can perform Stock lookups. 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 not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStockView

void useComparativeStockView()

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.

usePlenaryStockView

void usePlenaryStockView()

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

useFederatedWarehouseView

void useFederatedWarehouseView()

Federates the view for methods in this session. A federated view will include stocks in catalogs which are children of this catalog in the warehouse hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedWarehouseView

void useIsolatedWarehouseView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this warehouse only.

Compliance:

mandatory - This method is must be implemented.

getStock

Stock getStock(Id stockId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

Gets the Stock specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Stock may have a different Id than requested, such as the case where a duplicate Id was assigned to a Stock and retained for compatibility.

Parameters:

stockId - the Id of the Stock to retrieve

Returns:

the returned Stock

Throws:

NotFoundException - no Stock found with the given Id

NullArgumentException - stockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocksByIds

StockList getStocksByIds(IdList stockIds)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets a StockList corresponding to the given IdList. In plenary mode, the returned list contains all of the stocks specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Stocks may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

stockIds - the list of Ids to retrieve

Returns:

the returned Stock list

Throws:

NotFoundException - an Id was not found

NullArgumentException - stockIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocksByGenusType

StockList getStocksByGenusType(Type stockGenusType)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a StockList corresponding to the given stock genus Type which does not include stocks of types derived from the specified Type. In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.

Parameters:

stockGenusType - a stock genus type

Returns:

the returned Stock list

Throws:

NullArgumentException - stockGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocksByParentGenusType

StockList getStocksByParentGenusType(Type stockGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a StockList corresponding to the given stock genus Type and include any additional stocks with genus types derived from the specified Type. In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.

Parameters:

stockGenusType - a stock genus type

Returns:

the returned Stock list

Throws:

NullArgumentException - stockGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocksByRecordType

StockList getStocksByRecordType(Type stockRecordType)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a StockList containing the given stock record Type. In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.

Parameters:

stockRecordType - a stock record type

Returns:

the returned Stock list

Throws:

NullArgumentException - stockRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocksBySKU

StockList getStocksBySKU(java.lang.String sku)
                         throws OperationFailedException,
                                PermissionDeniedException

Gets a StockList containing for the given SKU. In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.

Parameters:

sku - a stock keeping unit

Returns:

the returned Stock list

Throws:

NullArgumentException - sku is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStocks

StockList getStocks()
                    throws OperationFailedException,
                           PermissionDeniedException

Gets all Stocks. In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.

Returns:

a list of Stocks

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.