Package com.atlassian.jira.notification

Class DefaultNotificationSchemeService

java.lang.Object

com.atlassian.jira.notification.DefaultNotificationSchemeService

All Implemented Interfaces:

NotificationSchemeService

public class DefaultNotificationSchemeService
extends Object
implements NotificationSchemeService

Since:

6.5

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_PAGE_RESULT

Constructor Summary

Constructors

Constructor	Description
DefaultNotificationSchemeService(NotificationSchemeManager notificationSchemeManager, EventTypeManager eventTypeManager, UserManager userManager, GroupManager groupManager, ProjectRoleManager projectRoleManager, CustomFieldManager customFieldManager, PermissionManager permissionManager, GlobalPermissionManager globalPermissionManager, I18nHelper i18n, ProjectManager projectManager)

Method Summary

Modifier and Type	Method	Description
ServiceOutcome<NotificationScheme>	getNotificationScheme(ApplicationUser user, Long id)	Returns the notification scheme for given id.
ServiceOutcome<NotificationScheme>	getNotificationSchemeForProject(ApplicationUser user, Long projectId)	Returns a notification scheme for the given project identified by the project's id.
ServiceOutcome<NotificationScheme>	getNotificationSchemeForProject(ApplicationUser user, String projectKey)	Returns a notification scheme for the given project identified by the project's key.
Page<NotificationScheme>	getNotificationSchemes(ApplicationUser user, PageRequest pageRequest)	Returns a page with notification schemes for the given PageRequest ordered by name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_PAGE_RESULT

public static final int MAX_PAGE_RESULT

See Also:

• Constant Field Values

Constructor Details

DefaultNotificationSchemeService

public DefaultNotificationSchemeService(NotificationSchemeManager notificationSchemeManager,
 EventTypeManager eventTypeManager,
 UserManager userManager,
 GroupManager groupManager,
 ProjectRoleManager projectRoleManager,
 CustomFieldManager customFieldManager,
 PermissionManager permissionManager,
 GlobalPermissionManager globalPermissionManager,
 I18nHelper i18n,
 ProjectManager projectManager)

Method Details

getNotificationScheme

public ServiceOutcome<NotificationScheme> getNotificationScheme(ApplicationUser user,
 @Nonnull
 Long id)

Description copied from interface: NotificationSchemeService

Returns the notification scheme for given id. This method executes a permission check, in order to have permissions to retrieve the notification scheme, the user is required to have permissions for administering at least one project associated with the notification scheme.

Specified by:

getNotificationScheme in interface NotificationSchemeService

Parameters:

user - user who requests the access to the notification scheme

id - id of the notification scheme to retrieve

Returns:

information about the notification scheme.

getNotificationSchemes

public Page<NotificationScheme> getNotificationSchemes(ApplicationUser user,
 @Nonnull
 PageRequest pageRequest)

Description copied from interface: NotificationSchemeService

Returns a page with notification schemes for the given PageRequest ordered by name. This method executes a permission check. User is required to have administer permissions on projects associated with the scheme in order to see it.

Specified by:

getNotificationSchemes in interface NotificationSchemeService

Parameters:

user - user who requests access to notification schemes.

pageRequest - information about the desired number of results and theirs offset.

Returns:

the page with notification schemes. The page may be empty.

getNotificationSchemeForProject

public ServiceOutcome<NotificationScheme> getNotificationSchemeForProject(ApplicationUser user,
 @Nonnull
 Long projectId)

Description copied from interface: NotificationSchemeService

Returns a notification scheme for the given project identified by the project's id.

Specified by:

getNotificationSchemeForProject in interface NotificationSchemeService

Parameters:

user - user who requests the access to the notification scheme

projectId - id of the project for which the associated notification scheme will be returned

Returns:

information about the notification scheme.

See Also:

• NotificationSchemeService.getNotificationScheme(ApplicationUser, Long)
• NotificationSchemeService.getNotificationSchemeForProject(ApplicationUser, String)

getNotificationSchemeForProject

public ServiceOutcome<NotificationScheme> getNotificationSchemeForProject(ApplicationUser user,
 @Nonnull
 String projectKey)

Description copied from interface: NotificationSchemeService

Returns a notification scheme for the given project identified by the project's key.

Specified by:

getNotificationSchemeForProject in interface NotificationSchemeService

Parameters:

user - user who requests the access to the notification scheme

projectKey - key of the project for which the associated notification scheme will be returned

Returns:

information about the notification scheme.

See Also:

• NotificationSchemeService.getNotificationScheme(ApplicationUser, Long)
• NotificationSchemeService.getNotificationSchemeForProject(ApplicationUser, Long)