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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ItemQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Items. The items may be sequenced using the ItemSearchOrder from this session.

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

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

Gets an item query.

Returnosid.inventory.ItemQuerythe item query
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchOrder
Description

Gets an item search order.

Returnosid.inventory.ItemSearchOrderthe item search order
CompliancemandatoryThis method must be implemented.
MethodapplyItemQuery
Description

Applies an item query to this warehouse.

Parametersosid.inventory.ItemQueryitemQuerythe item query
ErrorsNULL_ARGUMENT itemQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED itemQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectItemQuery
Description

Gets an item query inspector for this warehouse.

Returnosid.inventory.ItemQueryInspectorthe item query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyItemSequencing
Description

Applies an item search order to this warehouse.

Parametersosid.inventory.ItemSearchOrderitemSearchOrderthe item search order
ErrorsNULL_ARGUMENT itemSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED itemSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetItemQueryFromInspector
Description

Gets an item query from an inspector.

Parametersosid.inventory.ItemQueryInspectoritemQueryInspectora query inspector
Returnosid.inventory.ItemQuerythe item query
ErrorsNULL_ARGUMENT itemQueryInspector is null
UNSUPPORTED itemQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.