org.osid.ordering.rules

Interface PriceEnablerNotificationSession

All Superinterfaces:

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

public interface PriceEnablerNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgePriceEnablerNotification(Id notificationId) Acknowledge a price enabelr notification.
boolean	canRegisterForPriceEnablerNotifications() Tests if this user can register for PriceEnabler notifications.
Store	getStore() Gets the Store associated with this session.
Id	getStoreId() Gets the Store Id associated with this session.
void	registerForChangedPriceEnabler(Id priceEnablerId) Registers for notification of an updated price enabler.
void	registerForChangedPriceEnablers() Registers for notification of updated store enabelrs.
void	registerForDeletedPriceEnabler(Id priceEnablerId) Registers for notification of a deleted price enabler.
void	registerForDeletedPriceEnablers() Registers for notification of deleted price enablers.
void	registerForNewPriceEnablers() Register for notifications of new price enablers.
void	reliablePriceEnablerNotifications() Reliable notifications are desired.
void	unreliablePriceEnablerNotifications() Unreliable notifications are desired.
void	useFederatedStoreView() Federates the view for methods in this session.
void	useIsolatedStoreView() Isolates the view for methods in this session.

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

getStoreId

Id getStoreId()

Gets the Store Id associated with this session.

Returns:

the Store Id associated with this session

Compliance:

mandatory - This method must be implemented.

getStore

Store getStore()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Store associated with this session.

Returns:

the store

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForPriceEnablerNotifications

boolean canRegisterForPriceEnablerNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedStoreView

void useFederatedStoreView()

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.

Compliance:

mandatory - This method is must be implemented.

useIsolatedStoreView

void useIsolatedStoreView()

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

Compliance:

mandatory - This method is must be implemented.

reliablePriceEnablerNotifications

void reliablePriceEnablerNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliablePriceEnablerNotifications

void unreliablePriceEnablerNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgePriceEnablerNotification

void acknowledgePriceEnablerNotification(Id notificationId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Acknowledge a price enabelr notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPriceEnablers

void registerForNewPriceEnablers()
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPriceEnablers

void registerForChangedPriceEnablers()
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPriceEnabler

void registerForChangedPriceEnabler(Id priceEnablerId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

priceEnablerId - the Id of the PriceEnabler to monitor

Throws:

NullArgumentException - priceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPriceEnablers

void registerForDeletedPriceEnablers()
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPriceEnabler

void registerForDeletedPriceEnabler(Id priceEnablerId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

priceEnablerId - the Id of the PriceEnabler to monitor

Throws:

NullArgumentException - priceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.