org.osid.ordering

Interface PriceScheduleNotificationSession

All Superinterfaces:

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

public interface PriceScheduleNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForPriceScheduleNotifications() Tests if this user can register for PriceSchedule notifications.
Store	getStore() Gets the Store associated with this session.
Id	getStoreId() Gets the Store Id associated with this session.
void	registerForChangedPriceSchedule(Id priceScheduleId) Registers for notification of an updated price schedule.
void	registerForChangedPriceSchedules() Registers for notification of updated price schedules.
void	registerForDeletedPriceSchedule(Id priceScheduleId) Registers for notification of a deleted price schedule.
void	registerForDeletedPriceSchedules() Registers for notification of deleted price schedules.
void	registerForNewPriceSchedules() Register for notifications of new prices.
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.

canRegisterForPriceScheduleNotifications

boolean canRegisterForPriceScheduleNotifications()

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.

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 price schedules 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 searches to this store only.

Compliance:

mandatory - This method is must be implemented.

registerForNewPriceSchedules

void registerForNewPriceSchedules()
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPriceSchedules

void registerForChangedPriceSchedules()
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPriceSchedule

void registerForChangedPriceSchedule(Id priceScheduleId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

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.

Parameters:

priceScheduleId - the Id of the PriceSchedule to monitor

Throws:

NotFoundException - a price schedule was not found identified by the given Id

NullArgumentException - priceScheduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPriceSchedules

void registerForDeletedPriceSchedules()
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPriceSchedule

void registerForDeletedPriceSchedule(Id priceScheduleId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

priceScheduleId - the Id of the PriceSchedule to monitor

Throws:

NotFoundException - s price schedule was not found identified by the given Id

NullArgumentException - priceScheduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.