Package jetbrains.buildServer.notification

Interface NotificationRulesHolder

All Known Subinterfaces:

SUser, SUserGroup, UserEx, UserGroupEx

All Known Implementing Classes:

AllUsersGroup, AssociatedUser, BaseUser, FeatureProviderNotificationRulesHolder, InMemoryUser, RestrictedUserImpl, SecuredUser, SecuredUserGroup, TestUser, UserGroupImpl, UserImpl

public interface NotificationRulesHolder

Represents the holder of notification rules.

Since:

4.5

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

See Also:

NotificationRulesManager

Method Summary

Modifier and Type	Method	Description
long	addNewRule(String notifierType, NotificationRule rule)	Adds new rule to the rules of specified user for specified notifier type.
void	applyOrder(String notifierType, long[] ruleIds)	Sorts the notification rules in the specified order.
Collection<Long>	findConflictingRules(String notifierType, WatchedBuilds watch)	Searches for rules which intersect with specified watched builds.
NotificationRule	findRuleById(long ruleId)	Searches for a rule with specified id.
List<NotificationRulesHolder>	getAllParentRulesHolders()	Returns all (direct and inherited) parent notification rules holders
List<NotificationRule>	getNotificationRules(String notifierType)	Returns the notification rules for specified notifier for this holder (user or group).
List<NotificationRulesHolder>	getParentRulesHolders()	Returns direct parent notification rules holders
void	removeRule(long ruleId)	Removes the rule with specified id.
void	removeRule(NotificationRule rule)	Removes the rule.
void	setNotificationRules(String notifierType, List<NotificationRule> rules)	Sets the notification rules for specified notifier.

Method Detail

getNotificationRules

@NotNull
List<NotificationRule> getNotificationRules(@NotNull
                                            String notifierType)

Returns the notification rules for specified notifier for this holder (user or group).

Parameters:

notifierType - type of the notifier

Returns:

list of notification rules for specified notifier

setNotificationRules

void setNotificationRules(@NotNull
                          String notifierType,
                          @NotNull
                          List<NotificationRule> rules)

Sets the notification rules for specified notifier.

Parameters:

notifierType - type of the notifier

rules - rules to save

removeRule

void removeRule(long ruleId)

Removes the rule with specified id.

Parameters:

ruleId - id of the rule

removeRule

void removeRule(@NotNull
                NotificationRule rule)

Removes the rule. Throws NotificationRuleChangedException if notification rule with same id was already changed. Does nothing if notification rule doesn't exist.

Parameters:

rule - rule to remove

applyOrder

void applyOrder(@NotNull
                String notifierType,
                @NotNull
                long[] ruleIds)

Sorts the notification rules in the specified order.

Parameters:

notifierType - type of the notifier

ruleIds - ids of the rules in the required order

addNewRule

long addNewRule(@NotNull
                String notifierType,
                @NotNull
                NotificationRule rule)
         throws DuplicateNotificationRuleException

Adds new rule to the rules of specified user for specified notifier type.

Parameters:

notifierType - type of the notifier

rule - rule to add

Returns:

the id of the newly created rule

Throws:

DuplicateNotificationRuleException - if similar rule already exists

findConflictingRules

@Nullable
Collection<Long> findConflictingRules(@NotNull
                                      String notifierType,
                                      @NotNull
                                      WatchedBuilds watch)

Searches for rules which intersect with specified watched builds.

Parameters:

notifierType - type of the notifier

watch - watched builds

Returns:

list of conflicting rules ids

findRuleById

@Nullable
NotificationRule findRuleById(long ruleId)

Searches for a rule with specified id.

Parameters:

ruleId - id of the rule

Returns:

a found rule, or null

getParentRulesHolders

@NotNull
List<NotificationRulesHolder> getParentRulesHolders()

Returns direct parent notification rules holders

Returns:

direct parent notification rules holders

getAllParentRulesHolders

@NotNull
List<NotificationRulesHolder> getAllParentRulesHolders()

Returns all (direct and inherited) parent notification rules holders

Returns:

all (direct and inherited) parent notification rules holders