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

This session defines methods to receive notifications on adds/changes to PriceSchedule objects. 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.

Notifications are triggered with changes to the PriceSchedule object itself. Adding and removing orders result in notifications available from the notification session for orders.

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

Tests if this user can register for PriceSchedule 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 price schedules 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 searches to this store only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewPriceSchedules
Description

Register for notifications of new prices. PriceScheduleReceiver.newPriceSchedules() is invoked when a new PriceSchedule is created.

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

Registers for notification of updated price schedules. PriceScheduleReceiver.changedPriceSchedules() is invoked when a price schedule is changed or prices are changed within it.

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

Registers for notification of an updated price schedule. PriceScheduleReceiver.changedPriceSchedules() is invoked when the specified price schedule is changed or prices are changed within it.

Parametersosid.id.IdpriceScheduleIdthe Id of the PriceSchedule to monitor
ErrorsNOT_FOUNDa price schedule was not found identified by the given Id
NULL_ARGUMENT priceScheduleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPriceSchedules
Description

Registers for notification of deleted price schedules. PriceScheduleReceiver.deletedPriceSchedules() is invoked when a price schedule is deleted.

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

Registers for notification of a deleted price schedule. PriceScheduleReceiver.deletedPriceSchedules() is invoked when the specified price schedule is deleted.

Parametersosid.id.IdpriceScheduleIdthe Id of the PriceSchedule to monitor
ErrorsNOT_FOUNDs price schedule was not found identified by the given Id
NULL_ARGUMENT priceScheduleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.