com.atlassian.jira.notification

Interface NotificationSchemeService

All Known Implementing Classes:

DefaultNotificationSchemeService

@PublicApi
public interface NotificationSchemeService

Service providing information about notification schemes.

Since:

7.0

Method Summary

Modifier and Type	Method and 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.

Method Detail

getNotificationScheme

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

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.

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

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

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.

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

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

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

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:

getNotificationScheme(ApplicationUser, Long), getNotificationSchemeForProject(ApplicationUser, String)

getNotificationSchemeForProject

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

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

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:

getNotificationScheme(ApplicationUser, Long), getNotificationSchemeForProject(ApplicationUser, Long)