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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PriceScheduleQuery can be retrieved from this session and mapped to this Store to create a virtual collection of PriceSchedules. The prices may be sequenced using the PriceScheduleSearchOrder from this session.

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

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

Gets a price schedule query.

Returnosid.ordering.PriceScheduleQuerythe price schedule query
CompliancemandatoryThis method must be implemented.
MethodgetPriceScheduleSearchOrder
Description

Gets a price schedule search order.

Returnosid.ordering.PriceScheduleSearchOrderthe price schedule search order
CompliancemandatoryThis method must be implemented.
MethodapplyPriceScheduleQuery
Description

Applies a price schedule query to this store.

Parametersosid.ordering.PriceScheduleQuerypriceQuerythe price schedule query
ErrorsNULL_ARGUMENT priceScheduleQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED priceScheduleQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPriceScheduleQuery
Description

Gets a price schedule query inspector for this store.

Returnosid.ordering.PriceScheduleQueryInspectorthe price schedule query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyPriceScheduleSequencing
Description

Applies a price schedule search order to this store.

Parametersosid.ordering.PriceScheduleSearchOrderpriceScheduleSearchOrderthe price schedule search order
ErrorsNULL_ARGUMENT priceScheduleSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED priceScheduleSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPriceScheduleQueryFromInspector
Description

Gets a price schedule query from an inspector.

Parametersosid.ordering.PriceScheduleQueryInspectorpriceScheduleQueryInspectora query inspector
Returnosid.ordering.PriceScheduleQuerythe price schedule query
ErrorsNULL_ARGUMENT priceScheduleQueryInspector is null
UNSUPPORTED priceScheduleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.