com.atlassian.jira.notification.type
Class SingleEmailAddress

java.lang.Object
  extended bycom.atlassian.jira.notification.type.AbstractNotificationType
      extended bycom.atlassian.jira.notification.type.SingleEmailAddress
All Implemented Interfaces:
NotificationType

public class SingleEmailAddress
extends AbstractNotificationType


Constructor Summary
SingleEmailAddress(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 emailAddress)
          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

SingleEmailAddress

public SingleEmailAddress(JiraAuthenticationContext jiraAuthenticationContext)
Method Detail

getRecipients

public List getRecipients(IssueEvent event,
                          String emailAddress)
Description copied from interface: NotificationType
Who is to be notified of an event.

Parameters:
event - The event, eg. issue created
emailAddress - 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


Copyright © 2002-2006 Atlassian. All Rights Reserved.