Summary: Methods | [Expand All]
public interface

NotificationType

com.atlassian.jira.notification.NotificationType
Known Indirect Subclasses

Class Overview

Type of notification recipient; single user, group, assignee, etc.

Notification types are registered in notification-event-types.xml.

Summary

Public Methods
boolean doValidation(String key, Map parameters)
Validate the configuration (the argument in getRecipients(com.atlassian.jira.event.issue.IssueEvent, String)) when it is entered in the "Add Notification" page.
String getArgumentDisplay(String argument)
Obtains the user-friendly display for the argument.
String getArgumentValue(String displayValue)
Obtains the raw parameter value to save for the given user entry user-friendly display value.
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).

Public Methods

public boolean doValidation (String key, Map parameters)

Validate the configuration (the argument in 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.

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.

public String getArgumentDisplay (String argument)

Obtains the user-friendly display for the argument. For example, returns a username for a key.

Parameters
argument Raw configuration value
Returns
  • Formatted configuration value.

public String getArgumentValue (String displayValue)

Obtains the raw parameter value to save for the given user entry user-friendly display value. For example, the user picker displays a username, but this needs to be stored in the configuration parameter as the user's key, instead.

Parameters
displayValue Value entered into the form (username, for example)
Returns
  • raw configuration value.

public String getDisplayName ()

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

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

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

Who is to be notified of an event.

Parameters
event The event, eg. issue created
argument Configuration from notification scheme, eg. group name, custom field id.
Returns

public String getType ()

Type identifier (currently unused).

Returns
  • Eg. "group"