OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.StockSmartWarehouseSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A StockQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Stocks. The stocks may be sequenced using the StockSearchOrder from this session.

This Warehouse has a default query that matches any stock and a default search order that specifies no sequencing. The queries may be examined using a StockQueryInspector. The query may be modified by converting the inspector back to a StockQuery.

MethodgetWarehouseId
Description

Gets the Warehouse Id associated with this session.

Returnosid.id.Idthe Warehouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetWarehouse
Description

Gets the Warehouse associated with this session.

Returnosid.inventory.Warehousethe warehouse
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartWarehouses
Description

Tests if this user can manage smart warehouses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart warehouse management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStockQuery
Description

Gets a stock query.

Returnosid.inventory.StockQuerythe stock query
CompliancemandatoryThis method must be implemented.
MethodgetStockSearchOrder
Description

Gets a stock search order.

Returnosid.inventory.StockSearchOrderthe stock search order
CompliancemandatoryThis method must be implemented.
MethodapplyStockQuery
Description

Applies a stock query to this warehouse.

Parametersosid.inventory.StockQuerystockQuerythe stock query
ErrorsNULL_ARGUMENT stockQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stockQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectStockQuery
Description

Gets a stock query inspector for this warehouse.

Returnosid.inventory.StockQueryInspectorthe stock query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyStockSequencing
Description

Applies a stock search order to this warehouse.

Parametersosid.inventory.StockSearchOrderstockSearchOrderthe stock search order
ErrorsNULL_ARGUMENT stockSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED stockSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStockQueryFromInspector
Description

Gets a stock query from an inspector.

Parametersosid.inventory.StockQueryInspectorstockQueryInspectora query inspector
Returnosid.inventory.StockQuerythe stock query
ErrorsNULL_ARGUMENT stockQueryInspector is null
UNSUPPORTED stockQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.