org.osid.inventory

Interface WarehouseQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

WarehouseSearchSession

public interface WarehouseQuerySession
extends OsidSession

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

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
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.

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

canSearchWarehouses

boolean canSearchWarehouses()

Tests if this user can perform Warehouse lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getWarehouseQuery

WarehouseQuery getWarehouseQuery()

Gets a warehouse query.

Returns:

the warehouse query

Compliance:

mandatory - This method must be implemented.

getWarehousesByQuery

WarehouseList getWarehousesByQuery(WarehouseQuery warehouseQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a list of Warehouses matching the given warehouse query.

Parameters:

warehouseQuery - the warehouse query

Returns:

the returned WarehouseList

Throws:

NullArgumentException - warehouseQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - warehouseQuery is not of this service

Compliance:

mandatory - This method must be implemented.