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

This session defines methods to receive notifications on adds/changes to Store 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 Store object itself. Adding and removing orders result in notifications available from the notification session for orders.

MethodcanRegisterForStoreNotifications
Description

Tests if this user can register for Store 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.
MethodregisterForNewStores
Description

Register for notifications of new stores. StoreReceiver.newStores() is invoked when a new Store is created.

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

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified store. StoreReceiver.newAncestorStore() is invoked when the specified store node gets a new ancestor.

Parametersosid.id.IdstoreIdthe Id of the Store node to monitor
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewStoreDescendants
Description

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified store. StoreReceiver.newDescendantStore() is invoked when the specified store node gets a new descendant.

Parametersosid.id.IdstoreIdthe Id of the Store node to monitor
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedStores
Description

Registers for notification of updated stores. StoreReceiver.changedStores() is invoked when a store is changed.

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

Registers for notification of an updated store. StoreReceiver.changedStores() is invoked when the specified store is changed.

Parametersosid.id.IdstoreIdthe Id of the Store to monitor
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedStores
Description

Registers for notification of deleted stores. StoreReceiver.deletedStores() is invoked when a store is deleted.

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

Registers for notification of a deleted store. StoreReceiver.deletedStores() is invoked when the specified store is deleted.

Parametersosid.id.IdstoreIdthe Id of the Store to monitor
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedStoreAncestors
Description

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified store StoreReceiver.deletedAncestor() is invoked when the specified store node loses an ancestor.

Parametersosid.id.IdstoreIdthe Id of the Store to monitor
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedStoreDescendants
Description

Registers for notification of an updated hierarchy structure that removes a descendant of the specified store. StoreReceiver.deletedDescendant() is invoked when the specified store node loses a descendant.

Parametersosid.id.IdstoreIdthe Id of the Store to monitor
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.