com.atlassian.jira.notification.type
Class SingleUser

java.lang.Object
  com.atlassian.jira.notification.type.AbstractNotificationType
      com.atlassian.jira.notification.type.SingleUser

All Implemented Interfaces:

NotificationType

public class SingleUser

extends AbstractNotificationType

Constructor Summary

SingleUser(JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

boolean	doValidation(String key, Map parameters) Validate the configuration (the argument in getRecipients(com.atlassian.jira.event.issue.IssueEvent, java.lang.String)) when it is entered in the "Add Notification" page.
String	getDisplayName() Text to display for this type, on the "Add Notification" page.
List	getRecipients(IssueEvent event, String username) 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

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleUser

public SingleUser(JiraAuthenticationContext jiraAuthenticationContext)

Method Detail

getRecipients

public List getRecipients(IssueEvent event,
                          String username)

Description copied from interface: NotificationType

Who is to be notified of an event.

Parameters:

event - The event, eg. issue created

username - 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.

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

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, java.lang.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