Interface InventorySearchSession

All Superinterfaces:

AutoCloseable, Closeable, InventoryQuerySession, OsidSession, OsidSession

public interface InventorySearchSession
extends InventoryQuerySession

This session provides methods for searching among Inventories . The search query is constructed using the InventoryQuery .

getInventoriesByQuery() is the basic search method and returns a list of Inventorys . A more advanced search may be performed with getInventorysBySearch() .It accepts an InventorySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getInventoriesBySearch() returns an InventorySearchResults that can be used to access the resulting InventoryList or be used to perform a search within the result set through InventorySearch .

This session defines views that offer differing behaviors for searching.

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

Inventories may have a query record indicated by their respective record types. The query record is accessed via the InventoryQuery .

Method Summary

Modifier and Type	Method	Description
InventorySearchResults	getInventoriesBySearch(InventoryQuery inventoryQuery, InventorySearch inventorySearch)	Gets the search results matching the given search query using the given search.
InventoryQuery	getInventoryQueryFromInspector(InventoryQueryInspector inventoryQueryInspector)	Gets an inventory query from an inspector.
InventorySearch	getInventorySearch()	Gets an inventory search.
InventorySearchOrder	getInventorySearchOrder()	Gets an inventory search order.

Methods inherited from interface Closeable

close

Methods inherited from interface InventoryQuerySession

canSearchInventories, getInventoriesByQuery, getInventoryQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView

Modifier and Type	Method	Description
boolean	canSearchInventories()	Tests if this user can perform Inventory lookups.
InventoryList	getInventoriesByQuery(InventoryQuery inventoryQuery)	Gets a list of Inventories matching the given inventory query.
InventoryQuery	getInventoryQuery()	Gets an inventory 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.

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

getInventorySearch

InventorySearch getInventorySearch()

Gets an inventory search.

Returns:

the inventory search

Compliance:

mandatory - This method must be implemented.

getInventorySearchOrder

InventorySearchOrder getInventorySearchOrder()

Gets an inventory search order. The InventorySearchOrder is supplied to an InventorySearch to specify the ordering of results.

Returns:

the inventory search order

Compliance:

mandatory - This method must be implemented.

getInventoriesBySearch

InventorySearchResults getInventoriesBySearch(InventoryQuery inventoryQuery,
 InventorySearch inventorySearch)
                                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inventoryQuery - the inventory query

inventorySearch - the inventory search

Returns:

the inventory search results

Throws:

NullArgumentException - inventoryQuery or inventorySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inventoryQuery or inventorySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getInventoryQueryFromInspector

InventoryQuery getInventoryQueryFromInspector(InventoryQueryInspector inventoryQueryInspector)

Gets an inventory query from an inspector. The inspector is available from an InventorySearchResults .

Parameters:

inventoryQueryInspector - an inventory query inspector

Returns:

the inventory query

Throws:

NullArgumentException - inventoryQueryInspector is null

UnsupportedException - inventoryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.