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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ModelQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Models. The models may be sequenced using the ModelSearchOrder from this session.

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

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

Gets a model query.

Returnosid.inventory.ModelQuerythe model query
CompliancemandatoryThis method must be implemented.
MethodgetModelSearchOrder
Description

Gets a model search order.

Returnosid.inventory.ModelSearchOrderthe model search order
CompliancemandatoryThis method must be implemented.
MethodapplyModelQuery
Description

Applies a model query to this warehouse.

Parametersosid.inventory.ModelQuerymodelQuerythe model query
ErrorsNULL_ARGUMENT modelQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED modelQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectModelQuery
Description

Gets a model query inspector for this warehouse.

Returnosid.inventory.ModelQueryInspectorthe model query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyModelSequencing
Description

Applies a model search order to this warehouse.

Parametersosid.inventory.ModelSearchOrdermodelSearchOrderthe model search order
ErrorsNULL_ARGUMENT modelSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED modelSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetModelQueryFromInspector
Description

Gets a model query from an inspector.

Parametersosid.inventory.ModelQueryInspectormodelQueryInspectora query inspector
Returnosid.inventory.ModelQuerythe model query
ErrorsNULL_ARGUMENT modelQueryInspector is null
UNSUPPORTED modelQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.