OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ProductSmartStoreSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProductQuery can be retrieved from this session and mapped to this Store to create a virtual collection of Products. The products may be sequenced using the ProductSearchOrder from this session.

This Store has a default query that matches any product and a default search order that specifies no sequencing. The queries may be examined using a ProductQueryInspector. The query may be modified by converting the inspector back to a ProductQuery.

MethodgetStoreId
Description

Gets the Store Id associated with this session.

Returnosid.id.Idthe Store Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetStore
Description

Gets the Store associated with this session.

Returnosid.ordering.Storethe Store associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartStores
Description

Tests if this user can manage smart stores. A return of true does not guarantee successful authorization. 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 store management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProductQuery
Description

Gets a product query.

Returnosid.ordering.ProductQuerythe product query
CompliancemandatoryThis method must be implemented.
MethodgetProductSearchOrder
Description

Gets a product search order.

Returnosid.ordering.ProductSearchOrderthe product search order
CompliancemandatoryThis method must be implemented.
MethodapplyProductQuery
Description

Applies a product query to this store.

Parametersosid.ordering.ProductQueryproductQuerythe product query
ErrorsNULL_ARGUMENT productQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED productQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectProductQuery
Description

Gets a product query inspector for this store.

Returnosid.ordering.ProductQueryInspectorthe product query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyProductSequencing
Description

Applies a product search order to this store.

Parametersosid.ordering.ProductSearchOrderproductSearchOrderthe product search order
ErrorsNULL_ARGUMENT productSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED productSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProductQueryFromInspector
Description

Gets a product query from an inspector.

Parametersosid.ordering.ProductQueryInspectorproductQueryInspectora query inspector
Returnosid.ordering.ProductQuerythe product query
ErrorsNULL_ARGUMENT productQueryInspector is null
UNSUPPORTED productQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.