com.atlassian.jira.notification

Class ErrorNotificationType

java.lang.Object

com.atlassian.jira.notification.type.AbstractNotificationType

com.atlassian.jira.notification.ErrorNotificationType

All Implemented Interfaces:

NotificationType

public class ErrorNotificationType
extends AbstractNotificationType
implements NotificationType

Constructor Summary

Constructors

Constructor and Description
ErrorNotificationType(String displayName)

Method Summary

Modifier and Type	Method and Description
boolean	doValidation(String key, Map parameters) Validate the configuration (the argument in NotificationType.getRecipients(com.atlassian.jira.event.issue.IssueEvent, String)) when it is entered in the "Add Notification" page.
String	getDisplayName() Text to display for this type, on the "Add Notification" page.
List<NotificationRecipient>	getRecipients(IssueEvent event, String argument) Who is to be notified of an event.
String	getType() Type identifier (currently unused).

Methods inherited from class com.atlassian.jira.notification.type.AbstractNotificationType

getArgumentDisplay, getArgumentValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.notification.NotificationType

getArgumentDisplay, getArgumentValue

Constructor Detail

ErrorNotificationType

public ErrorNotificationType(String displayName)

Method Detail

getRecipients

public List<NotificationRecipient> getRecipients(IssueEvent event,
                                                 String argument)

Description copied from interface: NotificationType

Who is to be notified of an event.

Specified by:

getRecipients in interface NotificationType

Parameters:

event - The event, eg. issue created

argument - Configuration from notification scheme, eg. group name, custom field id.

Returns:

A list of NotificationRecipients.

getDisplayName

public String getDisplayName()

Description copied from interface: NotificationType

Text to display for this type, on the "Add Notification" page.

Specified by:

getDisplayName in interface NotificationType

Returns:

(Internationalized) text to display, eg. "Group".

getType

public String getType()

Description copied from interface: NotificationType

Type identifier (currently unused).

Specified by:

getType in interface NotificationType

Overrides:

getType in class AbstractNotificationType

Returns:

Eg. "group"

doValidation

public boolean doValidation(String key,
                            Map parameters)

Description copied from interface: NotificationType

Validate the configuration (the argument in NotificationType.getRecipients(com.atlassian.jira.event.issue.IssueEvent, String)) when it is entered in the "Add Notification" page. For instance, a group notification type might check if the entered group exists.

Specified by:

doValidation in interface NotificationType

Overrides:

doValidation in class AbstractNotificationType

Parameters:

key - Key of relevant value in parameters

parameters - HTML form parameters (only the keyed entry is relevant).

Returns:

Whether the entered value is valid for this type.