org.osid.inventory

Interface InventorySearchSession

All Superinterfaces:

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

public interface InventorySearchSession
extends InventoryQuerySession

This session provides methods for searching among Inventory objects. 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

Methods

Modifier and Type	Method and 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 org.osid.inventory.InventoryQuerySession

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

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

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.