|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NotificationType
Type of notification recipient; single user, group, assignee, etc. Notification types are registered in notification-event-types.xml.
Method Summary | |
---|---|
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 |
getArgumentValue(String displayValue)
Obtains the raw parameter value to save for the given user entry user-friendly display value. |
String |
getDisplayName()
Text to display for this type, on the "Add Notification" page. |
List<NotificationRecipient> |
getRecipients(IssueEvent event,
String argument)
Who is to be notified of an event. |
String |
getType()
Type identifier (currently unused). |
Method Detail |
---|
List<NotificationRecipient> getRecipients(IssueEvent event, String argument)
event
- The event, eg. issue createdargument
- Configuration from notification scheme, eg. group name, custom field id.
NotificationRecipient
s.String getDisplayName()
String getType()
boolean doValidation(String key, Map parameters)
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.
key
- Key of relevant value in parametersparameters
- HTML form parameters (only the keyed entry is relevant).
String getArgumentDisplay(String argument)
argument
- Raw configuration value
String getArgumentValue(String displayValue)
displayValue
- Value entered into the form (username, for example)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |