org.osid.ordering

Interface StoreNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface StoreNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForStoreNotifications() Tests if this user can register for Store notifications.
void	registerForChangedStore(Id storeId) Registers for notification of an updated store.
void	registerForChangedStores() Registers for notification of updated stores.
void	registerForDeletedStore(Id storeId) Registers for notification of a deleted store.
void	registerForDeletedStoreAncestors(Id storeId) 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.
void	registerForDeletedStoreDescendants(Id storeId) Registers for notification of an updated hierarchy structure that removes a descendant of the specified store.
void	registerForDeletedStores() Registers for notification of deleted stores.
void	registerForNewStoreAncestors(Id storeId) Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified store.
void	registerForNewStoreDescendants(Id storeId) Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified store.
void	registerForNewStores() Register for notifications of new stores.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canRegisterForStoreNotifications

boolean canRegisterForStoreNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

registerForNewStores

void registerForNewStores()
                          throws OperationFailedException,
                                 PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewStoreAncestors

void registerForNewStoreAncestors(Id storeId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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.

Parameters:

storeId - the Id of the Store node to monitor

Throws:

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewStoreDescendants

void registerForNewStoreDescendants(Id storeId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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.

Parameters:

storeId - the Id of the Store node to monitor

Throws:

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedStores

void registerForChangedStores()
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedStore

void registerForChangedStore(Id storeId)
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

storeId - the Id of the Store to monitor

Throws:

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedStores

void registerForDeletedStores()
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedStore

void registerForDeletedStore(Id storeId)
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

storeId - the Id of the Store to monitor

Throws:

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedStoreAncestors

void registerForDeletedStoreAncestors(Id storeId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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.

Parameters:

storeId - the Id of the Store to monitor

Throws:

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedStoreDescendants

void registerForDeletedStoreDescendants(Id storeId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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.

Parameters:

storeId - the Id of the Store to monitor

Throws:

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.