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

This session provides methods to apply PriceEnablers to Prices. A Price with multiple PriceEnablers means any positive rule evaluation across the enablers result in an effective Price.

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

Tests if this user can alter price enabler/price mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignPriceEnablerToPrice
Description

Adds an existing PriceEnabler to a Price.

Parametersosid.id.IdpriceEnablerIdthe Id of the PriceEnabler
osid.id.IdpriceIdthe Id of the Price
ErrorsALREADY_EXISTS priceEnablerId is already applied to priceId
NOT_FOUND priceEnablerId or priceId not found
NULL_ARGUMENT priceEnablerId or priceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignPriceEnablerFromPrice
Description

Removes a PriceEnabler from a Price.

Parametersosid.id.IdpriceEnablerIdthe Id of the PriceEnabler
osid.id.IdpriceIdthe Id of the Price
ErrorsNOT_FOUND priceEnablerId or priceId not found or priceEnablerId is not applied to priceId
NULL_ARGUMENT priceEnablerId or priceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequencePriceEnablers
Description

Tests if this user can order ProceEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if PriceEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmovePriceEnablerAhead
Description

Reorders price enablers for a price by moving the specified price enabler in front of a reference price enabler.

Parametersosid.id.IdpriceEnablerIdthe Id of a PriceEnabler
osid.id.IdpriceIdthe Id of a Price
osid.id.IdreferenceIdthe reference price enabler Id
ErrorsNOT_FOUND priceEnablerId, priceId, or referenceId not found or, priceEnablerId or referenceId not related to priceId
NULL_ARGUMENT priceEnablerId, priceId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmovePriceEnablerBehind
Description

Reorders price enablers for a price by moving the specified price enabler behind a reference price enabler.

Parametersosid.id.IdpriceEnablerIdthe Id of a PriceEnabler
osid.id.IdpriceIdthe Id of a Price
osid.id.IdreferenceIdthe reference price enabler Id
ErrorsNOT_FOUND priceEnablerId, priceId, or referenceId not found or, priceEnablerId or referenceId not related to priceId
NULL_ARGUMENT priceEnablerId, priceId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderPriceEnablers
Description

Reorders a set of price enablers for an price.

Parametersosid.id.Id[]priceEnablerIdsthe Ids for a set of PriceEnablers
osid.id.IdpriceIdthe Id of a Price
ErrorsNOT_FOUND priceId not found or, a priceEnablerId not related to priceId
NULL_ARGUMENT priceEnablerIds or priceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.