org.osid.inventory

Interface ItemSearchSession

All Superinterfaces:

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

public interface ItemSearchSession
extends ItemQuerySession

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

getItemsByQuery() is the basic search method and returns a list of Items. A more advanced search may be performed with getItemsBySearch(). It accepts an ItemSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getItemsBySearch() returns an ItemSearchResults that can be used to access the resulting ItemList or be used to perform a search within the result set through ItemSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
ItemQuery	getItemQueryFromInspector(ItemQueryInspector itemQueryInspector) Gets an item query from an inspector.
ItemSearchResults	getItemsBySearch(ItemQuery itemQuery, ItemSearch itemSearch) Gets the search results matching the given search query using the given search.
ItemSearch	getItemSearch() Gets an item search.
ItemSearchOrder	getItemSearchOrder() Gets an inventory search order.

Methods inherited from interface org.osid.inventory.ItemQuerySession

canSearchItems, getItemQuery, getItemsByQuery, 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

getItemSearch

ItemSearch getItemSearch()

Gets an item search.

Returns:

the item search

Compliance:

mandatory - This method must be implemented.

getItemSearchOrder

ItemSearchOrder getItemSearchOrder()

Gets an inventory search order. The ItemSearchOrder is supplied to an ItemSearch to specify the ordering of results.

Returns:

the item search order

Compliance:

mandatory - This method must be implemented.

getItemsBySearch

ItemSearchResults getItemsBySearch(ItemQuery itemQuery,
                                 ItemSearch itemSearch)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

itemQuery - the item query

itemSearch - the item search

Returns:

the item search results

Throws:

NullArgumentException - itemQuery or itemSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - itemQuery or itemSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getItemQueryFromInspector

ItemQuery getItemQueryFromInspector(ItemQueryInspector itemQueryInspector)

Gets an item query from an inspector. The inspector is available from an ItemSearchResults.

Parameters:

itemQueryInspector - an item query inspector

Returns:

the item query

Throws:

NullArgumentException - itemQueryInspector is null

UnsupportedException - itemQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.