public class

GroupCFValue

extends AbstractNotificationType
java.lang.Object
   ↳ com.atlassian.jira.notification.type.AbstractNotificationType
     ↳ com.atlassian.jira.notification.type.GroupCFValue

Class Overview

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.

Summary

Constants
String ID
Public Constructors
GroupCFValue(JiraAuthenticationContext jiraAuthenticationContext, GroupSelectorUtils groupSelectorUtils, FieldManager fieldManager)
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 getDisplayName()
List getFields()
Used in the UI layer.
List<NotificationRecipient> getRecipients(IssueEvent event, String customFieldId)
String getType()
Type identifier (currently unused).
[Expand]
Inherited Methods
From class com.atlassian.jira.notification.type.AbstractNotificationType
From class java.lang.Object
From interface com.atlassian.jira.notification.NotificationType

Constants

public static final String ID

Constant Value: "Group_Custom_Field_Value"

Public Constructors

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

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 getDisplayName ()

public List getFields ()

Used in the UI layer.

Returns
  • list of group-related custom fields

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

public String getType ()

Type identifier (currently unused).

Returns
  • Eg. "group"