|
||||||||||
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(java.lang.String key,
java.util.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. |
java.lang.String |
getArgumentDisplay(java.lang.String argument)
Displays the type's configuration in the notification scheme. |
java.lang.String |
getDisplayName()
Text to display for this type, on the "Add Notification" page. |
java.util.List<NotificationRecipient> |
getRecipients(IssueEvent event,
java.lang.String argument)
Who is to be notified of an event. |
java.lang.String |
getType()
Type identifier (currently unused). |
Method Detail |
---|
java.util.List<NotificationRecipient> getRecipients(IssueEvent event, java.lang.String argument)
event
- The event, eg. issue createdargument
- Configuration from notification scheme, eg. group name, custom field id.
NotificationRecipient
s.java.lang.String getDisplayName()
java.lang.String getType()
boolean doValidation(java.lang.String key, java.util.Map parameters)
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.
key
- Key of relevant value in parametersparameters
- HTML form parameters (only the keyed entry is relevant).
java.lang.String getArgumentDisplay(java.lang.String argument)
argument
- Raw configuration value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |