public interface InventorySmartWarehouseSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An InventoryQuery
can be retrieved from this
session and mapped to this Warehouse
to create a virtual
collection of Inventories.
The inventories may be sequenced
using the InventorySearchOrder
from this session.
This Warehouse
has a default query that matches any
inventory and a default search order that specifies no sequencing. The
queries may be examined using an InventoryQueryInspector.
The query may be modified by converting the inspector back to an
InventoryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyInventoryQuery(InventoryQuery inventoryQuery)
Applies an inventory query to this warehouse.
|
void |
applyInventorySequencing(InventorySearchOrder inventorySearchOrder)
Applies an inventory search order to this warehouse.
|
boolean |
canManageSmartWarehouses()
Tests if this user can manage smart warehouses.
|
InventoryQuery |
getInventoryQuery()
Gets an inventory query.
|
InventoryQuery |
getInventoryQueryFromInspector(InventoryQueryInspector inventoryQueryInspector)
Gets an inventory query from an inspector.
|
InventorySearchOrder |
getInventorySearchOrder()
Gets an inventory search order.
|
Warehouse |
getWarehouse()
Gets the
Warehouse associated with this session. |
Id |
getWarehouseId()
Gets the
Warehouse Id associated with
this session. |
InventoryQueryInspector |
inspectInventoryQuery()
Gets an inventory query inspector for this warehouse.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getWarehouseId()
Warehouse
Id
associated with
this session. Warehouse Id
associated with this sessionmandatory
- This method must be implemented. Warehouse getWarehouse() throws OperationFailedException, PermissionDeniedException
Warehouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartWarehouses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart warehouse management is not
authorized, true
otherwisemandatory
- This method must be implemented. InventoryQuery getInventoryQuery()
mandatory
- This method must be implemented. InventorySearchOrder getInventorySearchOrder()
mandatory
- This method must be implemented. void applyInventoryQuery(InventoryQuery inventoryQuery) throws OperationFailedException, PermissionDeniedException
inventoryQuery
- the inventory queryNullArgumentException
- inventoryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inventoryQuery
not of this servicemandatory
- This method must be implemented. InventoryQueryInspector inspectInventoryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyInventorySequencing(InventorySearchOrder inventorySearchOrder) throws OperationFailedException, PermissionDeniedException
inventorySearchOrder
- the inventory search orderNullArgumentException
- inventorySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inventorySearchOrder
not of this servicemandatory
- This method must be implemented. InventoryQuery getInventoryQueryFromInspector(InventoryQueryInspector inventoryQueryInspector)
inventoryQueryInspector
- a query inspectorNullArgumentException
- inventoryQueryInspector
is null
UnsupportedException
- inventoryQueryInspector
is not of this servicemandatory
- This method must be implemented.