Interface WarehouseSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, WarehouseQuerySession

public interface WarehouseSearchSession
extends WarehouseQuerySession

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

Modifier and Type	Method	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 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 WarehouseQuerySession

canSearchWarehouses, getWarehouseQuery, getWarehousesByQuery

Modifier and Type	Method	Description
boolean	canSearchWarehouses()	Tests if this user can perform Warehouse lookups.
WarehouseQuery	getWarehouseQuery()	Gets a warehouse query.
WarehouseList	getWarehousesByQuery(WarehouseQuery warehouseQuery)	Gets a list of Warehouses matching the given warehouse query.

Method Details

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.