Package com.atlassian.jira.notification
Interface NotificationSchemeManager
- All Superinterfaces:
SchemeManager
- All Known Implementing Classes:
DefaultNotificationSchemeManager
-
Field Summary
Fields inherited from interface com.atlassian.jira.scheme.SchemeManager
PROJECT_ASSOCIATION
-
Method Summary
Modifier and TypeMethodDescriptionList<org.ofbiz.core.entity.GenericValue>
getEntities
(org.ofbiz.core.entity.GenericValue scheme) Get all Scheme entity records for a particular scheme.List<org.ofbiz.core.entity.GenericValue>
getEntities
(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId) Inherited from SchemeManager.List<org.ofbiz.core.entity.GenericValue>
getEntities
(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId, String parameter) Deprecated.Not used - presumably this was invented in SchemeManager for Permission Schemes.List<org.ofbiz.core.entity.GenericValue>
getEntities
(org.ofbiz.core.entity.GenericValue scheme, String entityTypeId) Deprecated.Never worked for Strings.List<org.ofbiz.core.entity.GenericValue>
getEntities
(org.ofbiz.core.entity.GenericValue scheme, String type, Long entityTypeId) Deprecated.Not used - presumably this was invented in SchemeManager for Permission Schemes.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.getRecipients
(IssueEvent event) Given an issue event this method returns a set ofNotificationRecipient
s who will receive an e-mail notificationgetRecipients
(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.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
void
removeSchemeEntitiesForField
(String fieldId) Methods inherited from interface com.atlassian.jira.scheme.SchemeManager
addDefaultSchemeToProject, addDefaultSchemeToProject, addSchemeToProject, addSchemeToProject, copyScheme, copyScheme, createDefaultScheme, createScheme, createSchemeAndEntities, createSchemeEntity, createSchemeObject, deleteEntities, deleteEntity, deleteScheme, getAssociatedSchemes, getDefaultScheme, getDefaultSchemeObject, getEntities, getEntitiesByIds, getEntity, getGroups, getGroups, getProjects, getScheme, getScheme, getSchemeFor, getSchemeIdFor, getSchemeObject, getSchemeObject, getSchemeObjects, getSchemes, getSchemes, getUnassociatedSchemes, getUsers, getUsers, getUsers, getUsers, removeEntities, removeEntities, removeSchemesFromProject, removeSchemesFromProject, schemeExists, swapParameterForEntitiesOfType, updateScheme, updateScheme
-
Method Details
-
getEntities
List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme) throws org.ofbiz.core.entity.GenericEntityException Get all Scheme entity records for a particular scheme. Inherited from SchemeManager.- Specified by:
getEntities
in interfaceSchemeManager
- Parameters:
scheme
- The scheme that the entities belong to- Returns:
- List of (GenericValue) entities
- Throws:
org.ofbiz.core.entity.GenericEntityException
- If a DB error occurs
-
getEntities
List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId) throws org.ofbiz.core.entity.GenericEntityException Inherited from SchemeManager.- Specified by:
getEntities
in interfaceSchemeManager
- Throws:
org.ofbiz.core.entity.GenericEntityException
-
getEntities
List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme, String entityTypeId) throws org.ofbiz.core.entity.GenericEntityException Deprecated.Never worked for Strings. Since v6.4.Inherited from SchemeManager.- Specified by:
getEntities
in interfaceSchemeManager
- Throws:
org.ofbiz.core.entity.GenericEntityException
-
getEntities
List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId, String parameter) throws org.ofbiz.core.entity.GenericEntityException Deprecated.Not used - presumably this was invented in SchemeManager for Permission Schemes.Inherited from SchemeManager.- Specified by:
getEntities
in interfaceSchemeManager
- Throws:
org.ofbiz.core.entity.GenericEntityException
-
getEntities
List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme, String type, Long entityTypeId) throws org.ofbiz.core.entity.GenericEntityException Deprecated.Not used - presumably this was invented in SchemeManager for Permission Schemes.Inherited from SchemeManager.- Specified by:
getEntities
in interfaceSchemeManager
- Throws:
org.ofbiz.core.entity.GenericEntityException
-
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 eventnotification
- 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
- Throws:
RemoveException
-
isHasMailServer
boolean isHasMailServer() throws com.atlassian.mail.MailException- Throws:
com.atlassian.mail.MailException
-
getRecipients
Given an issue event this method returns a set ofNotificationRecipient
s 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 projectentityTypeId
- 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
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 typeparameter
- is the scheme entries parameter value- Returns:
- Collection of GenericValues that represents a scheme
-