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

This session provides methods to retrieve PriceEnabler to Store mappings. A PriceEnabler may appear in multiple Store objects. Each store may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupPriceEnablerStoreMappings
Description

Tests if this user can perform lookups of price enabler/store mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativePriceEnablerStoreView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryPriceEnablerStoreView
Description

A complete view of the PriceEnabler and Store returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetPriceEnablerIdsByStore
Description

Gets the list of PriceEnablerIds associated with an Store.

Parametersosid.id.IdstoreId Id of the Store
Returnosid.id.IdListlist of related price enabler Ids
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablersByStore
Description

Gets the list of price enablers associated with an Store.

Parametersosid.id.IdstoreId Id of the Store
Returnosid.ordering.rules.PriceEnablerListlist of related price enablers
ErrorsNOT_FOUND storeId is not found
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablerIdsByStores
Description

Gets the list of PriceEnabler Ids corresponding to a list of Stores.

Parametersosid.id.IdListstoreIdslist of store Ids
Returnosid.id.IdListlist of price enabler Ids
ErrorsNULL_ARGUMENT storeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablersByStores
Description

Gets the list of price enablers corresponding to a list of Stores.

Parametersosid.id.IdListstoreIdslist of store Ids
Returnosid.ordering.rules.PriceEnablerListlist of price enablers
ErrorsNULL_ARGUMENT storeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoreIdsByPriceEnabler
Description

Gets the Store Ids mapped to a PriceEnabler.

Parametersosid.id.IdpriceEnablerId Id of a PriceEnabler
Returnosid.id.IdListlist of stores
ErrorsNOT_FOUND priceEnablerId is not found
NULL_ARGUMENT priceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStoresByPriceEnabler
Description

Gets the Stores mapped to a PriceEnabler.

Parametersosid.id.IdpriceEnablerId Id of a PriceEnabler
Returnosid.ordering.StoreListlist of stores
ErrorsNOT_FOUND priceEnablerId is not found
NULL_ARGUMENT priceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.