org.osid.calendaring.rules

Interface RecurringEventEnablerNotificationSession

All Superinterfaces:

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

public interface RecurringEventEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to RecurringEventEnabler objects in this Calendar. This also includes existing RecirringEventEnablers that may appear or disappear due to changes in the Calendar 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 RecurringEventEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeRecurringEventEnablerNotification(Id notificationId) Acknowledge a recurring event enabler notification.
boolean	canRegisterForRecurringEventEnablerNotifications() Tests if this user can register for RecurringEventEnabler notifications.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
void	registerForChangedRecurringEventEnabler(Id recurringEventEnablerId) Registers for notification of an updated offset event enabler.
void	registerForChangedRecurringEventEnablers() Registers for notification of updated calendar enablers.
void	registerForDeletedRecurringEventEnabler(Id recurringEventEnablerId) Registers for notification of a deleted offset event enabler.
void	registerForDeletedRecurringEventEnablers() Registers for notification of deleted offset event enablers.
void	registerForNewRecurringEventEnablers() Register for notifications of new offset event enablers.
void	reliableRecurringEventEnablerNotifications() Reliable notifications are desired.
void	unreliableRecurringEventEnablerNotifications() Unreliable notifications are desired.
void	useFederatedCalendarView() Federates the view for methods in this session.
void	useIsolatedCalendarView() 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

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the calendar

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForRecurringEventEnablerNotifications

boolean canRegisterForRecurringEventEnablerNotifications()

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

useFederatedCalendarView

void useFederatedCalendarView()

Federates the view for methods in this session. A federated view will include enablers in calendars which are children of this calendar in the calendar hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCalendarView

void useIsolatedCalendarView()

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

Compliance:

mandatory - This method is must be implemented.

reliableRecurringEventEnablerNotifications

void reliableRecurringEventEnablerNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliableRecurringEventEnablerNotifications

void unreliableRecurringEventEnablerNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgeRecurringEventEnablerNotification

void acknowledgeRecurringEventEnablerNotification(Id notificationId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Acknowledge a recurring event enabler notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewRecurringEventEnablers

void registerForNewRecurringEventEnablers()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of new offset event enablers. RecurringEventEnablerReceiver.newRecurringEventEnablers() is invoked when a new RecurringEventEnabler appears in this calendar.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRecurringEventEnablers

void registerForChangedRecurringEventEnablers()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of updated calendar enablers. RecurringEventEnablerReceiver.changedRecurringEventEnablers() is invoked when a recurring event enabler in this calendar is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRecurringEventEnabler

void registerForChangedRecurringEventEnabler(Id recurringEventEnablerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of an updated offset event enabler. RecurringEventEnablerReceiver.changedRecurringEventEnablers() is invoked when the specified offset event enabler in this calendar is changed.

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler to monitor

Throws:

NullArgumentException - recurringEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRecurringEventEnablers

void registerForDeletedRecurringEventEnablers()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of deleted offset event enablers. RecurringEventEnablerReceiver.deletedRecurringEventEnablers() is invoked when an offset event enabler is deleted or removed from this calendar.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRecurringEventEnabler

void registerForDeletedRecurringEventEnabler(Id recurringEventEnablerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of a deleted offset event enabler. RecurringEventEnablerReceiver.deletedRecurringEventEnablers() is invoked when the specified offset event enabler is deleted or removed from this calendar.

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler to monitor

Throws:

NullArgumentException - recurringEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.