com.atlassian.jira.notification.type
Class GroupCFValue

java.lang.Object
  extended by com.atlassian.jira.notification.type.AbstractNotificationType
      extended by com.atlassian.jira.notification.type.GroupCFValue
All Implemented Interfaces:
NotificationType

public class GroupCFValue
extends AbstractNotificationType

Group Custom Field notification type. Configured with a custom field, it interprets the custom field's value as a group name, and then notifies members of that group.

Since:
3.6

Field Summary
static String ID
           
 
Constructor Summary
GroupCFValue(JiraAuthenticationContext jiraAuthenticationContext, GroupSelectorUtils groupSelectorUtils, FieldManager fieldManager)
           
 
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)
          Obtains the user-friendly display for the argument.
 String getDisplayName()
          Text to display for this type, on the "Add Notification" page.
 List getFields()
          Used in the UI layer.
 List<NotificationRecipient> getRecipients(IssueEvent event, String customFieldId)
          Who is to be notified of an event.
 String getType()
          Type identifier (currently unused).
 
Methods inherited from class com.atlassian.jira.notification.type.AbstractNotificationType
getArgumentValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
See Also:
Constant Field Values
Constructor Detail

GroupCFValue

public GroupCFValue(JiraAuthenticationContext jiraAuthenticationContext,
                    GroupSelectorUtils groupSelectorUtils,
                    FieldManager fieldManager)
Method Detail

getRecipients

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

Parameters:
event - The event, eg. issue created
customFieldId - 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
Returns:
Eg. "group"

getFields

public List getFields()
Used in the UI layer.

Returns:
list of group-related custom fields

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.

getArgumentDisplay

public String getArgumentDisplay(String argument)
Description copied from interface: NotificationType
Obtains the user-friendly display for the argument. For example, returns a username for a key.

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


Copyright © 2002-2013 Atlassian. All Rights Reserved.