public interface NotificationType extends BambooPluginModule, Comparable
Modifier and Type | Interface and Description |
---|---|
static class |
NotificationType.Scope |
Modifier and Type | Method and Description |
---|---|
String |
getConfigurationData()
Returns the string representation of the configurable data of the notification type to be persisted to the db
|
String |
getDescription()
Returns generic string description of this notification type
|
String |
getEditHtml()
Returns the html to be displayed on the edit screen (to input data into notification type)
|
String |
getKey()
returns key for this condition object
|
com.atlassian.plugin.web.descriptors.WeightedDescriptor |
getModuleDescriptor()
returns the moduleDescriptor for this plugin object if it exists.
|
String |
getName()
Returns a short name of the notification type
|
NotificationType.Scope |
getScope()
The scope of the notification type be it "plan" or "system" or "chain"
|
String |
getViewHtml()
Returns the HTML representing the notification type for the notification
|
void |
init(com.atlassian.plugin.web.descriptors.WeightedDescriptor moduleDescriptor)
initialises the notification type plugin object with its module descriptor
|
boolean |
isNotificationRequired(Object event)
Determines whether or not a notification should be sent based on the event.
|
void |
populate(Map<String,String[]> params)
takes the map of config data from action and extracts the parameters it needs
|
void |
setConfigurationData(String data)
initalises the notification type object with its data based on the config string retrieved from the database
|
ErrorCollection |
validate(Map<String,String[]> params)
validate the user inputed data
|
compareTo
void init(@NotNull com.atlassian.plugin.web.descriptors.WeightedDescriptor moduleDescriptor)
moduleDescriptor
- for this plugin object@Nullable com.atlassian.plugin.web.descriptors.WeightedDescriptor getModuleDescriptor()
void setConfigurationData(@Nullable String data)
data
- string representation of configurable data@NotNull String getConfigurationData()
@NotNull String getName()
@NotNull String getDescription()
@NotNull String getKey()
void populate(@NotNull Map<String,String[]> params)
params
- map of key (String), value (String []) pairs from action@NotNull ErrorCollection validate(@NotNull Map<String,String[]> params)
params
- map of key (String), value (String []) pairs from action@NotNull String getEditHtml()
@NotNull String getViewHtml()
boolean isNotificationRequired(@NotNull Object event)
event
- NotificationType.Scope getScope()
Copyright © 2019 Atlassian Software Systems Pty Ltd. All rights reserved.