Interface StockSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, StockQuerySession

public interface StockSearchSession
extends StockQuerySession

This session provides methods for searching among Stocks . The search query is constructed using the StockQuery .

getStocksByQuery() is the basic search method and returns a list of Stocks . A more advanced search may be performed with getStocksBySearch() . It accepts a StockSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getStocksBySearch() returns a StockSearchResults that can be used to access the resulting StockList or be used to perform a search within the result set through StockSearch .

This session defines views that offer differing behaviors for searching.

• federated warehouse view: searches include stocks in warehouses of which this warehouse is an ancestor in the warehouse hierarchy
• isolated warehouse view: searches are restricted to stocks in this warehouse

Stocks may have a query record indicated by their respective record types. The queryrecord is accessed via the StockQuery .

Method Summary

Modifier and Type	Method	Description
StockQuery	getStockQueryFromInspector(ItemQueryInspector stockQueryInspector)	Gets a stock query from an inspector.
StockSearchResults	getStocksBySearch(StockQuery stockQuery, StockSearch stockSearch)	Gets the search results matching the given search query using the given search.
StockSearch	getStockSearch()	Gets a stock search.
StockSearchOrder	getStockSearchOrder()	Gets a stock search order.

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.

Methods inherited from interface StockQuerySession

canSearchStocks, getStockQuery, getStocksByQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView

Modifier and Type	Method	Description
boolean	canSearchStocks()	Tests if this user can perform Stock lookups.
StockQuery	getStockQuery()	Gets a stock query.
StockList	getStocksByQuery(StockQuery stockQuery)	Gets a list of Stocks matching the given stock query.
Warehouse	getWarehouse()	Gets the Warehouse associated with this session.
Id	getWarehouseId()	Gets the Warehouse Id associated with this session.
void	useFederatedWarehouseView()	Federates the view for methods in this session.
void	useIsolatedWarehouseView()	Isolates the view for methods in this session.

Method Details

getStockSearch

StockSearch getStockSearch()

Gets a stock search.

Returns:

the stock search

Compliance:

mandatory - This method must be implemented.

getStockSearchOrder

StockSearchOrder getStockSearchOrder()

Gets a stock search order. The StockSearchOrder is supplied to a StockSearch to specify the ordering of results.

Returns:

the stock search order

Compliance:

mandatory - This method must be implemented.

getStocksBySearch

StockSearchResults getStocksBySearch(StockQuery stockQuery,
 StockSearch stockSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

stockQuery - the stock query

stockSearch - the stock search

Returns:

the stock search results

Throws:

NullArgumentException - stockQuery or stockSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stockQuery or stockSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStockQueryFromInspector

StockQuery getStockQueryFromInspector(ItemQueryInspector stockQueryInspector)

Gets a stock query from an inspector. The inspector is available from a StockSearchResults .

Parameters:

stockQueryInspector - a stock query inspector

Returns:

the stock query

Throws:

NullArgumentException - stockQueryInspector is null

UnsupportedException - stockQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.