com.atlassian.bamboo.notification

Interface NotificationDao

All Superinterfaces:

BambooObjectDao, bucket.core.persistence.ObjectDao

All Known Implementing Classes:

NotificationHibernateDao

public interface NotificationDao
extends BambooObjectDao

Method Summary

Modifier and Type	Method and Description
void	deleteNotification(NotificationRule rule) Used to remove a notification from db.
List<UsersNotification>	getNotificationRulesForRecipients(String recipientType, Collection<String> recipients) Retrieve all notification rules of a specific type matching the given list of recipient values.
List<UsersNotification>	getNotificationRulesForRecipientType(String recipientType) Retrieve All notification rules with a specific recipient type (useful for retrieveing watchers and committers)
List<NotificationSet>	getNotificationSetsForType(NotificationSet.NotificationSetType type) Retrieve notification sets belonging to a specific type.
void	saveNotificationRule(NotificationRule newRule) Save new/existing notification rule
void	saveNotificationSet(NotificationSet notificationSet) Save new/existing notification set.

Methods inherited from interface com.atlassian.bamboo.persistence.BambooObjectDao

findById

Methods inherited from interface bucket.core.persistence.ObjectDao

findAll, findAllSorted, getPersistentClass, refresh, remove, replicate, save, saveRaw

Method Detail

deleteNotification

void deleteNotification(NotificationRule rule)

Used to remove a notification from db. This should cascade to delete associated recipients

Parameters:

rule - Complete NotificationRule Object

saveNotificationRule

void saveNotificationRule(NotificationRule newRule)

Save new/existing notification rule

Parameters:

newRule - New or Existing NotificationRule Object

saveNotificationSet

void saveNotificationSet(@NotNull
                         NotificationSet notificationSet)

Save new/existing notification set.

Parameters:

notificationSet - New or existing notification set. Must be an instance of EntityObject.

Throws:

IllegalArgumentException - If the given notification set is not an instance of EntityObject

getNotificationRulesForRecipients

@NotNull
List<UsersNotification> getNotificationRulesForRecipients(@NotNull
                                                                   String recipientType,
                                                                   @NotNull
                                                                   Collection<String> recipients)

Retrieve all notification rules of a specific type matching the given list of recipient values.

Parameters:

recipientType - the key of the recipient type to search for

recipients - a list of values to match (eg email addresses, usernames etc)

Returns:

getNotificationRulesForRecipientType

@NotNull
List<UsersNotification> getNotificationRulesForRecipientType(String recipientType)

Retrieve All notification rules with a specific recipient type (useful for retrieveing watchers and committers)

Parameters:

recipientType -

Returns:

getNotificationSetsForType

@NotNull
List<NotificationSet> getNotificationSetsForType(NotificationSet.NotificationSetType type)

Retrieve notification sets belonging to a specific type.

Parameters:

type - to be retrieved

Returns:

List of notification sets.