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

This session defines methods to receive notifications on adds/changes to PriceEnabler objects in this Store. This also includes existing PriceEnablers that may appear or disappear due to changes in the Store hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the PriceEnablerLookupSession.

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

Tests if this user can register for PriceEnabler notifications. 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 opt not to offer notification operations.

Returnboolean false if notification 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 enablers in stores which are children of this store in the store hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedStoreView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliablePriceEnablerNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgePriceEnablerNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliablePriceEnablerNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgePriceEnablerNotification
Description

Acknowledge a price enabelr notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPriceEnablers
Description

Register for notifications of new price enablers. PriceEnablerReceiver.newPriceEnablers() is invoked when a new PriceEnabler appears in this store.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPriceEnablers
Description

Registers for notification of updated store enabelrs. PriceEnablerReceiver.changedPriceEnablers() is invoked when a price enabler in this store is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPriceEnabler
Description

Registers for notification of an updated price enabler. ProvisionableReceiver.changedPriceEnablers() is invoked when the specified price enabler in this store is changed.

Parametersosid.id.IdpriceEnablerIdthe Id of the PriceEnabler to monitor
ErrorsNULL_ARGUMENT priceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPriceEnablers
Description

Registers for notification of deleted price enablers. PriceEnablerReceiver.deletedPriceEnablers() is invoked when a price enabler is deleted or removed from this store.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPriceEnabler
Description

Registers for notification of a deleted price enabler. PriceEnablerReceiver.deletedPriceEnablers() is invoked when the specified price enabler is deleted or removed from this store.

Parametersosid.id.IdpriceEnablerIdthe Id of the PriceEnabler to monitor
ErrorsNULL_ARGUMENT priceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.