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

This session manages queries and sequencing to create "smart" dynamic catalogs. An OrderQuery can be retrieved from this session and mapped to this Store to create a virtual collection of Orders. The orders may be sequenced using the OrderSearchOrder from this session.

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

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

Gets an order query.

Returnosid.ordering.OrderQuerythe order query
CompliancemandatoryThis method must be implemented.
MethodgetOrderSearchOrder
Description

Gets an order search order.

Returnosid.ordering.OrderSearchOrderthe order search order
CompliancemandatoryThis method must be implemented.
MethodapplyOrderQuery
Description

Applies an order query to this store.

Parametersosid.ordering.OrderQueryorderQuerythe order query
ErrorsNULL_ARGUMENT orderQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED orderQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectOrderQuery
Description

Gets an order query inspector for this store.

Returnosid.ordering.OrderQueryInspectorthe order query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyOrderSequencing
Description

Applies an order search order to this store.

Parametersosid.ordering.OrderSearchOrderorderSearchOrderthe order search order
ErrorsNULL_ARGUMENT orderSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED orderSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOrderQueryFromInspector
Description

Gets an order query from an inspector.

Parametersosid.ordering.OrderQueryInspectororderQueryInspectora query inspector
Returnosid.ordering.OrderQuerythe order query
ErrorsNULL_ARGUMENT orderQueryInspector is null
UNSUPPORTED orderQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.