Interface | osid.ordering.PriceScheduleNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | getStoreId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Store Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getStore | ||
Description |
Gets the | ||
Return | osid.ordering.Store | the store | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForPriceScheduleNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedStoreView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedStoreView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this store only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewPriceSchedules | ||
Description |
Register for notifications of new prices. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPriceSchedules | ||
Description |
Registers for notification of updated price schedules.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPriceSchedule | ||
Description |
Registers for notification of an updated price
schedule. | ||
Parameters | osid.id.Id | priceScheduleId | the Id of the PriceSchedule to monitor |
Errors | NOT_FOUND | a price schedule was not found identified by the given Id | |
NULL_ARGUMENT | priceScheduleId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPriceSchedules | ||
Description |
Registers for notification of deleted price schedules.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPriceSchedule | ||
Description |
Registers for notification of a deleted price schedule.
| ||
Parameters | osid.id.Id | priceScheduleId | the Id of the PriceSchedule to monitor |
Errors | NOT_FOUND | s price schedule was not found identified by the given Id | |
NULL_ARGUMENT | priceScheduleId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |