public interface

NotificationSchemeManager

implements SchemeManager
com.atlassian.jira.notification.NotificationSchemeManager
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From interface com.atlassian.jira.scheme.SchemeManager
Public Methods
List<SchemeEntity> getNotificationSchemeEntities(Project project, long entityTypeId)
Get the notification scheme entities for this project and entity type.
GenericValue getNotificationSchemeForProject(GenericValue projectGV)
Get the notification scheme for this project.
Set<NotificationRecipient> getRecipients(IssueEvent event, SchemeEntity notification)
Retrieve the set of recipients for the event using the specified notification entity.
Set<NotificationRecipient> getRecipients(IssueEvent event)
Given an issue event this method returns a set of NotificationRecipients who will receive an e-mail notification
Collection<GenericValue> getSchemesContainingEntity(String type, String parameter)
This is a method that is meant to quickly get you all the schemes that contain an entity of the specified type and parameter.
Map<LongString> getSchemesMapByConditions(Map<String, ?> conditions)
Retrieve a map of scheme ids to scheme names that match the specified conditions.
boolean hasEntities(GenericValue scheme, Long event, String type, String parameter, Long templateId)
boolean isHasMailServer()
void removeSchemeEntitiesForField(String fieldId)
[Expand]
Inherited Methods
From interface com.atlassian.jira.scheme.SchemeManager

Public Methods

public List<SchemeEntity> getNotificationSchemeEntities (Project project, long entityTypeId)

Get the notification scheme entities for this project and entity type.

Returns an empty List if there problems (e.g. more than one scheme association for the Project) encountered.

Parameters
project the project
entityTypeId the type of entity
Returns
  • notificationSchemeEntities scheme entities representing the notifications for the project
Throws
GenericEntityException

public GenericValue getNotificationSchemeForProject (GenericValue projectGV)

Get the notification scheme for this project. There should be only one.

Returns null if there problems (e.g. more than one scheme association) encountered.

Parameters
projectGV the project
Returns
  • notificationScheme the GenericValue object representing a notification scheme

public Set<NotificationRecipient> getRecipients (IssueEvent event, SchemeEntity notification)

Retrieve the set of recipients for the event using the specified notification entity.

Parameters
event issue event
notification scheme entity
Returns
  • a Set of notification recipients
Throws
GenericEntityException

public Set<NotificationRecipient> getRecipients (IssueEvent event)

Given an issue event this method returns a set of NotificationRecipients who will receive an e-mail notification

Parameters
event The issue event that triggered the notification
Returns
  • A Set of recipients that will receive e-mails for this event.

public Collection<GenericValue> getSchemesContainingEntity (String type, String parameter)

This is a method that is meant to quickly get you all the schemes that contain an entity of the specified type and parameter.

Parameters
type is the entity type
parameter is the scheme entries parameter value
Returns
  • Collection of GenericValues that represents a scheme

public Map<LongString> getSchemesMapByConditions (Map<String, ?> conditions)

Retrieve a map of scheme ids to scheme names that match the specified conditions.

Parameters
conditions Map of conditions on which to limit the search
Returns
  • Map scheme ids -> scheme names

public boolean hasEntities (GenericValue scheme, Long event, String type, String parameter, Long templateId)

Throws
GenericEntityException

public boolean isHasMailServer ()

Throws
MailException

public void removeSchemeEntitiesForField (String fieldId)