org.bedework.calsvci

Interface NotificationsI

All Superinterfaces:

Serializable

public interface NotificationsI
extends Serializable

Interface for handling bedework notifications - including CalDAV user notification collections.

Author:

Mike Douglass

Method Summary

Modifier and Type	Method and Description
boolean	add(org.bedework.caldav.util.notifications.NotificationType val) Add the given notification to the notification collection for the current principal.
org.bedework.caldav.util.notifications.NotificationType	find(String name) Find a notification in the notification collection for the current principal with the given name.
org.bedework.caldav.util.notifications.NotificationType	find(String principalHref, String name) Find a notification in the notification collection for the given principal with the given name.
List<org.bedework.caldav.util.notifications.NotificationType>	getAll()
List<org.bedework.caldav.util.notifications.NotificationType>	getMatching(BwPrincipal pr, QName type)
List<org.bedework.caldav.util.notifications.NotificationType>	getMatching(QName type)
List<org.bedework.caldav.util.notifications.NotificationType>	getMatching(String href, QName type)
void	remove(org.bedework.caldav.util.notifications.NotificationType val) Remove the given notification from the notification collection for the current calendar user.
void	remove(String principalHref, org.bedework.caldav.util.notifications.NotificationType val) Remove the given notification from the notification collection for the indicated calendar user.
void	remove(String principalHref, String name) Remove a notification in the notification collection for the given principal with the given name.
void	removeAll(String principalHref) Remove all the notification from the notification collection for the given calendar user.
boolean	send(BwPrincipal pr, org.bedework.caldav.util.notifications.NotificationType val) Add the given notification to the notification collection for the indicated principal.
void	subscribe(String principalHref, List<String> emails) Subscribe to a notification service.
void	unsubscribe(String principalHref, List<String> emails) Subscribe to a notification service.
boolean	update(org.bedework.caldav.util.notifications.NotificationType val) Update the given notification

Method Detail

send

boolean send(BwPrincipal pr,
             org.bedework.caldav.util.notifications.NotificationType val)
      throws CalFacadeException

Add the given notification to the notification collection for the indicated principal.

Parameters:

pr - - target

val - - the notification

Returns:

false for unknown CU

Throws:

CalFacadeException

add

boolean add(org.bedework.caldav.util.notifications.NotificationType val)
     throws CalFacadeException

Add the given notification to the notification collection for the current principal. Caller should check for notifications enabled if appropriate.

Parameters:

val - - the notification

Returns:

false for no notification or collection

Throws:

CalFacadeException

update

boolean update(org.bedework.caldav.util.notifications.NotificationType val)
        throws CalFacadeException

Update the given notification

Parameters:

val - - the notification

Returns:

false for no notification or collection

Throws:

CalFacadeException

find

org.bedework.caldav.util.notifications.NotificationType find(String name)
                                                      throws CalFacadeException

Find a notification in the notification collection for the current principal with the given name.

Parameters:

name - - of the notification

Returns:

null for no notification or the notification with that name

Throws:

CalFacadeException

find

org.bedework.caldav.util.notifications.NotificationType find(String principalHref,
                                                             String name)
                                                      throws CalFacadeException

Find a notification in the notification collection for the given principal with the given name.

Parameters:

principalHref - - target

name - - of the notification

Returns:

null for no notification or the notification with that name

Throws:

CalFacadeException

remove

void remove(String principalHref,
            String name)
     throws CalFacadeException

Remove a notification in the notification collection for the given principal with the given name.

Parameters:

principalHref - - target

name - - of the notification

Throws:

CalFacadeException

remove

void remove(String principalHref,
            org.bedework.caldav.util.notifications.NotificationType val)
     throws CalFacadeException

Remove the given notification from the notification collection for the indicated calendar user. Must have access to the collection.

Parameters:

principalHref - - target

val - - the notification

Throws:

CalFacadeException

remove

void remove(org.bedework.caldav.util.notifications.NotificationType val)
     throws CalFacadeException

Remove the given notification from the notification collection for the current calendar user.

Parameters:

val - - the notification

Throws:

CalFacadeException

removeAll

void removeAll(String principalHref)
        throws CalFacadeException

Remove all the notification from the notification collection for the given calendar user.

Parameters:

principalHref - - the principal

Throws:

CalFacadeException

getAll

List<org.bedework.caldav.util.notifications.NotificationType> getAll()
                                                              throws CalFacadeException

Returns:

all notifications for this user

Throws:

CalFacadeException

getMatching

List<org.bedework.caldav.util.notifications.NotificationType> getMatching(QName type)
                                                                   throws CalFacadeException

Parameters:

type - of notification (null for all)

Returns:

matching notifications for this user - never null

Throws:

CalFacadeException

getMatching

List<org.bedework.caldav.util.notifications.NotificationType> getMatching(BwPrincipal pr,
                                                                          QName type)
                                                                   throws CalFacadeException

Parameters:

pr - principal

type - of notification (null for all)

Returns:

notifications for the given principal of the given type

Throws:

CalFacadeException

getMatching

List<org.bedework.caldav.util.notifications.NotificationType> getMatching(String href,
                                                                          QName type)
                                                                   throws CalFacadeException

Parameters:

href - principal href

type - of notification (null for all)

Returns:

notifications for the given principal of the given type

Throws:

CalFacadeException

subscribe

void subscribe(String principalHref,
               List<String> emails)
        throws CalFacadeException

Subscribe to a notification service.

Throws:

CalFacadeException

unsubscribe

void unsubscribe(String principalHref,
                 List<String> emails)
          throws CalFacadeException

Subscribe to a notification service.

Throws:

CalFacadeException