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

This session manages queries and sequencing to create "smart" dynamic stores. A PriceEnablerQuery can be retrieved from this session and mapped to this Store to create a virtual collection of price enablers. The price enablers may be sequenced using the PriceEnablerSearchOrder from this session.

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

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

Gets a price enabler query.

Returnosid.ordering.rules.PriceEnablerQuerythe price enabler query
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablerSearchOrder
Description

Gets a price enabler search order.

Returnosid.ordering.rules.PriceEnablerSearchOrderthe price enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyPriceEnablerQuery
Description

Applies a price enabler query to this store.

Parametersosid.ordering.rules.PriceEnablerQuerypriceEnablerQuerythe price enabler query
ErrorsNULL_ARGUMENT priceEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED priceEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPriceEnablerQuery
Description

Gets a price enabler query inspector for this store.

Returnosid.ordering.rules.PriceEnablerQueryInspectorthe price enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyPriceEnablerSequencing
Description

Applies a price enabler search order to this store.

Parametersosid.ordering.rules.PriceEnablerSearchOrderpriceEnablerSearchOrderthe price enabler search order
ErrorsNULL_ARGUMENT priceEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED priceEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablerQueryFromInspector
Description

Gets a price enabler query from an inspector.

Parametersosid.ordering.rules.PriceEnablerQueryInspectorpriceEnablerQueryInspectora price enabler query inspector
Returnosid.ordering.rules.PriceEnablerQuerythe price enabler query
ErrorsNULL_ARGUMENT priceEnablerQueryInspector is null
UNSUPPORTED priceEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.