com.atlassian.jira.notification
Interface NotificationSchemeManager

All Superinterfaces:

SchemeManager

All Known Implementing Classes:

DefaultNotificationSchemeManager

public interface NotificationSchemeManager
extends SchemeManager

Field Summary

Fields inherited from interface com.atlassian.jira.scheme.SchemeManager

PROJECT_ASSOCIATION

Method Summary

List<SchemeEntity>	getNotificationSchemeEntities(Project project, long entityTypeId) Get the notification scheme entities for this project and entity type.
org.ofbiz.core.entity.GenericValue	getNotificationSchemeForProject(org.ofbiz.core.entity.GenericValue projectGV) Get the notification scheme for this project.
Set<NotificationRecipient>	getRecipients(IssueEvent event) Given an issue event this method returns a set of NotificationRecipients who will receive an e-mail notification
Set<NotificationRecipient>	getRecipients(IssueEvent event, SchemeEntity notification) Retrieve the set of recipients for the event using the specified notification entity.
Collection<org.ofbiz.core.entity.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<Long,String>	getSchemesMapByConditions(Map<String,?> conditions) Retrieve a map of scheme ids to scheme names that match the specified conditions.
boolean	hasEntities(org.ofbiz.core.entity.GenericValue scheme, Long event, String type, String parameter, Long templateId)
boolean	isHasMailServer()
void	removeSchemeEntitiesForField(String fieldId)

Methods inherited from interface com.atlassian.jira.scheme.SchemeManager

addDefaultSchemeToProject, addDefaultSchemeToProject, addSchemeToProject, addSchemeToProject, copyScheme, copyScheme, createDefaultScheme, createScheme, createSchemeAndEntities, createSchemeEntity, createSchemeObject, deleteEntity, deleteScheme, getAssociatedSchemes, getDefaultScheme, getDefaultSchemeObject, getEntities, getEntities, getEntities, getEntities, getEntities, getEntities, getEntity, getGroups, getGroups, getProjects, getProjects, getScheme, getScheme, getSchemeFor, getSchemeObject, getSchemeObject, getSchemeObjects, getSchemes, getSchemes, getUnassociatedSchemes, getUsers, getUsers, getUsers, getUsers, hasSchemeAuthority, hasSchemeAuthority, removeEntities, removeEntities, removeSchemesFromProject, removeSchemesFromProject, schemeExists, updateScheme, updateScheme

Method Detail

getRecipients

Set<NotificationRecipient> getRecipients(IssueEvent event,
                                         SchemeEntity notification)
                                         throws org.ofbiz.core.entity.GenericEntityException

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:

org.ofbiz.core.entity.GenericEntityException

hasEntities

boolean hasEntities(org.ofbiz.core.entity.GenericValue scheme,
                    Long event,
                    String type,
                    String parameter,
                    Long templateId)
                    throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

removeSchemeEntitiesForField

void removeSchemeEntitiesForField(String fieldId)
                                  throws RemoveException

Throws:

RemoveException

isHasMailServer

boolean isHasMailServer()
                        throws com.atlassian.mail.MailException

Throws:

com.atlassian.mail.MailException

getRecipients

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.

Since:

v5.0

getNotificationSchemeEntities

List<SchemeEntity> getNotificationSchemeEntities(Project project,
                                                 long entityTypeId)
                                                 throws org.ofbiz.core.entity.GenericEntityException

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:

org.ofbiz.core.entity.GenericEntityException

getNotificationSchemeForProject

org.ofbiz.core.entity.GenericValue getNotificationSchemeForProject(org.ofbiz.core.entity.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

getSchemesMapByConditions

Map<Long,String> 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

getSchemesContainingEntity

Collection<org.ofbiz.core.entity.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