com.atlassian.jira.notification.type
Class AbstractNotificationType

java.lang.Object
  extended by com.atlassian.jira.notification.type.AbstractNotificationType
All Implemented Interfaces:
NotificationType
Direct Known Subclasses:
AllWatchers, ComponentLead, CurrentAssignee, CurrentReporter, ErrorNotificationType, GroupCFValue, GroupDropdown, ProjectLead, RemoteUser, SingleEmailAddress, SingleUser, UserCFValue

public abstract class AbstractNotificationType
extends Object
implements NotificationType


Constructor Summary
AbstractNotificationType()
           
 
Method Summary
 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 getArgumentDisplay(String argument)
          Displays the type's configuration in the notification scheme.
 String getType()
          Type identifier (currently unused).
 
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
getDisplayName, getRecipients
 

Constructor Detail

AbstractNotificationType

public AbstractNotificationType()
Method Detail

getType

public String getType()
Description copied from interface: NotificationType
Type identifier (currently unused).

Specified by:
getType in interface NotificationType
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
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.

getArgumentDisplay

public String getArgumentDisplay(String argument)
Description copied from interface: NotificationType
Displays the type's configuration in the notification scheme. Eg. shows the group name, or custom field name.

Specified by:
getArgumentDisplay in interface NotificationType
Parameters:
argument - Raw configuration value
Returns:
Formatted configuration value.


Copyright © 2002-2012 Atlassian. All Rights Reserved.