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

This session provides methods for searching among PriceEnabler objects. The search query is constructed using the PriceEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated store view: searches include price enablers in stores of which this store is an ancestor in the store hierarchy
  • isolated store view: searches are restricted to price enablers in this store

Price enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchPriceEnablers
Description

Tests if this user can perform PriceEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedStoreView
Description

Federates the view for methods in this session. A federated view will include price enablers in stores which are children of this broker in the store hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedStoreView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this store only.

CompliancemandatoryThis method is must be implemented.
MethodgetPriceEnablerQuery
Description

Gets a price enabler query.

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

Gets a list of PriceEnablers matching the given price enabler query.

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