OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.WarehouseSearchSession
Implementsosid.inventory.WarehouseQuerySession
Description

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.

MethodgetWarehouseSearch
Description

Gets a warehouse search.

Returnosid.inventory.WarehouseSearchthe warehouse search
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseSearchOrder
Description

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

Returnosid.inventory.WarehouseSearchOrderthe warehouse search order
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesBySearch
Description

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

Parametersosid.inventory.WarehouseQuerywarehouseQuerythe warehouse query
osid.inventory.WarehouseSearchwarehouseSearchthe warehouse search
Returnosid.inventory.WarehouseSearchResultsthe warehouse search results
ErrorsNULL_ARGUMENT warehouseQuery or warehouseSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED warehouseQuery or warehouseSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseQueryFromInspector
Description

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

Parametersosid.inventory.WarehouseQueryInspectorwarehouseQueryInspectora warehouse query inspector
Returnosid.inventory.WarehouseQuerythe warehouse query
ErrorsNULL_ARGUMENT warehouseQueryInspector is null
UNSUPPORTED warehouseQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.