org.osid.inventory

Interface WarehouseSearchSession

All Superinterfaces:

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

public interface WarehouseSearchSession
extends WarehouseQuerySession

This session provides methods for searching among Warehouse objects. The search query is constructed using the WarehouseQuery.

getWarehousesByQuery() is the basic search method and returns a list of Warehouses. A more advanced search may be performed with getWarehousesBySearch(). It accepts a WarehouseSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getWarehousesBySearch() returns a WarehouseSearchResults that can be used to access the resulting WarehouseList or be used to perform a search within the result set through Warehousesearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
WarehouseQuery	getWarehouseQueryFromInspector(WarehouseQueryInspector warehouseQueryInspector) Gets a warehouse query from an inspector.
WarehouseSearchResults	getWarehousesBySearch(WarehouseQuery warehouseQuery, WarehouseSearch warehouseSearch) Gets the search results matching the given search query using the given search.
WarehouseSearch	getWarehouseSearch() Gets a warehouse search.
WarehouseSearchOrder	getWarehouseSearchOrder() Gets a warehouse search order.

Methods inherited from interface org.osid.inventory.WarehouseQuerySession

canSearchWarehouses, getWarehouseQuery, getWarehousesByQuery

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

getWarehouseSearch

WarehouseSearch getWarehouseSearch()

Gets a warehouse search.

Returns:

the warehouse search

Compliance:

mandatory - This method must be implemented.

getWarehouseSearchOrder

WarehouseSearchOrder getWarehouseSearchOrder()

Gets a warehouse search order. The WarehouseSearchOrder is supplied to a WarehouseSearch to specify the ordering of results.

Returns:

the warehouse search order

Compliance:

mandatory - This method must be implemented.

getWarehousesBySearch

WarehouseSearchResults getWarehousesBySearch(WarehouseQuery warehouseQuery,
                                           WarehouseSearch warehouseSearch)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

warehouseQuery - the warehouse query

warehouseSearch - the warehouse search

Returns:

the warehouse search results

Throws:

NullArgumentException - warehouseQuery or warehouseSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - warehouseQuery or warehouseSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getWarehouseQueryFromInspector

WarehouseQuery getWarehouseQueryFromInspector(WarehouseQueryInspector warehouseQueryInspector)

Gets a warehouse query from an inspector. The inspector is available from a WarehousesearchResults.

Parameters:

warehouseQueryInspector - a warehouse query inspector

Returns:

the warehouse query

Throws:

NullArgumentException - warehouseQueryInspector is null

UnsupportedException - warehouseQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.