com.atlassian.jira.issue.fields.config

Interface PrioritySchemeService

All Known Implementing Classes:

DefaultPrioritySchemeService

public interface PrioritySchemeService

Responsible for properly handling data when project is re-assigned to another priority scheme or the scheme is deleted.

Since:

7.7

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PrioritySchemeService.PrioritySchemeData

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<FieldConfigScheme>	assignProject(ApplicationUser user, FieldConfigScheme priorityFieldConfig, Project project) Associates a project with a priority scheme.
ServiceOutcome<FieldConfigScheme>	assignProject(ApplicationUser user, Long schemeId, io.atlassian.fugue.Either<Long,String> projectKeyOrId, boolean failIfMigrationNeeded) Associates a project with a priority scheme.
ServiceOutcome<FieldConfigScheme>	assignProjects(ApplicationUser user, FieldConfigScheme priorityFieldConfig, Collection<Project> projects) Associates projects with a priority scheme.
ServiceOutcome<FieldConfigScheme>	createScheme(ApplicationUser user, PrioritySchemeService.PrioritySchemeData prioritySchemeData) Creates the scheme wih given data.
ServiceResult	deleteScheme(ApplicationUser user, FieldConfigScheme priorityFieldConfig) Deletes the scheme and associates it's project with the default priority scheme.
ServiceResult	deleteScheme(ApplicationUser user, Long id) Deletes the scheme and associates it's project with the default priority scheme.
ServiceOutcome<FieldConfigScheme>	editScheme(ApplicationUser user, FieldConfigScheme priorityFieldConfig, List<String> optionIds, String defaultOption) Updates the scheme wih given data.
ServiceOutcome<FieldConfigScheme>	editScheme(ApplicationUser user, PrioritySchemeService.PrioritySchemeData data, boolean failIfMigrationNeeded) Updates the scheme wih given data.
List<Project>	filterProjectsNotPossibleToAssociate(List<Project> projects) Filters out projects which shouldn't be associated to priority scheme (e.g.
ServiceOutcome<FieldConfigScheme>	getScheme(ApplicationUser user, Long id) Gets the scheme wih given id.
ServiceOutcome<FieldConfigScheme>	getSchemeForProject(ApplicationUser user, io.atlassian.fugue.Either<Long,String> projectKeyOrId) Gets the scheme for given project key.
ServiceOutcome<Collection<FieldConfigScheme>>	getSchemes(ApplicationUser user) Gets all priority schemes.
boolean	hasAnyNotPossibleToAssociateProject(Collection<Project> projects) Checks if in given list there is at least one not able to associate project (e.g.
ServiceResult	schemeDataValidate(ApplicationUser user, PrioritySchemeService.PrioritySchemeData prioritySchemeData) Validates if passed PrioritySchemeService.PrioritySchemeData can be used to create/edit priority scheme.
ServiceOutcome<FieldConfigScheme>	unassignProject(ApplicationUser user, Long schemeId, io.atlassian.fugue.Either<Long,String> projectKeyOrId) Deassociates a project from a priority scheme.

Method Detail

assignProjects

ServiceOutcome<FieldConfigScheme> assignProjects(@Nonnull
                                                 ApplicationUser user,
                                                 @Nullable
                                                 FieldConfigScheme priorityFieldConfig,
                                                 @Nonnull
                                                 Collection<Project> projects)

Associates projects with a priority scheme.

Parameters:

user - Application user

priorityFieldConfig - the priority scheme. Should the scheme be null - association with default scheme is assumed.

projects - the Collection of projects to assign

Returns:

ServiceOutcome with affected FieldConfigScheme

assignProject

ServiceOutcome<FieldConfigScheme> assignProject(@Nonnull
                                                ApplicationUser user,
                                                @Nullable
                                                FieldConfigScheme priorityFieldConfig,
                                                @Nonnull
                                                Project project)

Associates a project with a priority scheme.

Parameters:

user - Application user

priorityFieldConfig - the priority scheme. Should the scheme be null - association with default scheme is assumed.

project - the project

Returns:

ServiceOutcome with affected FieldConfigScheme

assignProject

ServiceOutcome<FieldConfigScheme> assignProject(@Nonnull
                                                ApplicationUser user,
                                                @Nullable
                                                Long schemeId,
                                                @Nonnull
                                                io.atlassian.fugue.Either<Long,String> projectKeyOrId,
                                                boolean failIfMigrationNeeded)

Associates a project with a priority scheme.

Parameters:

user - Application user

schemeId - id of the priority scheme.

projectKeyOrId - key of id of the project

failIfMigrationNeeded - whether validation should fail if migration is needed

Returns:

ServiceOutcome with affected FieldConfigScheme

unassignProject

ServiceOutcome<FieldConfigScheme> unassignProject(@Nonnull
                                                  ApplicationUser user,
                                                  @Nullable
                                                  Long schemeId,
                                                  @Nonnull
                                                  io.atlassian.fugue.Either<Long,String> projectKeyOrId)

Deassociates a project from a priority scheme.

Parameters:

user - Application user

schemeId - id of the priority scheme.

projectKeyOrId - key or id of the project

Returns:

ServiceOutcome with affected FieldConfigScheme

editScheme

ServiceOutcome<FieldConfigScheme> editScheme(@Nonnull
                                             ApplicationUser user,
                                             @Nonnull
                                             FieldConfigScheme priorityFieldConfig,
                                             @Nonnull
                                             List<String> optionIds,
                                             String defaultOption)

Updates the scheme wih given data.

Parameters:

user - Application user

priorityFieldConfig - the priority scheme to edit. The default priority scheme can not be edited.

optionIds - new list of priorities in the scheme

defaultOption - default priority of the scheme

Returns:

ServiceOutcome with affected FieldConfigScheme

editScheme

ServiceOutcome<FieldConfigScheme> editScheme(@Nonnull
                                             ApplicationUser user,
                                             @Nonnull
                                             PrioritySchemeService.PrioritySchemeData data,
                                             boolean failIfMigrationNeeded)

Updates the scheme wih given data.

Parameters:

user - Application user

data - priority scheme data

failIfMigrationNeeded - whether validation should fail if migration is needed

Returns:

ServiceOutcome with affected FieldConfigScheme

deleteScheme

ServiceResult deleteScheme(@Nonnull
                           ApplicationUser user,
                           @Nonnull
                           FieldConfigScheme priorityFieldConfig)

Deletes the scheme and associates it's project with the default priority scheme.

Parameters:

user - Application user

priorityFieldConfig - the priority scheme to delete. The default priority scheme can not be deleted.

Returns:

result of operation

deleteScheme

ServiceResult deleteScheme(@Nonnull
                           ApplicationUser user,
                           @Nonnull
                           Long id)

Deletes the scheme and associates it's project with the default priority scheme.

Parameters:

user - Application user

id - id of the priority scheme to delete. The default priority scheme can not be deleted.

Returns:

result of operation

createScheme

ServiceOutcome<FieldConfigScheme> createScheme(@Nonnull
                                               ApplicationUser user,
                                               @Nonnull
                                               PrioritySchemeService.PrioritySchemeData prioritySchemeData)

Creates the scheme wih given data.

Parameters:

user - Application user

prioritySchemeData - data of the priority scheme to create.

Returns:

ServiceOutcome with newly created FieldConfigScheme

getScheme

ServiceOutcome<FieldConfigScheme> getScheme(@Nonnull
                                            ApplicationUser user,
                                            @Nonnull
                                            Long id)

Gets the scheme wih given id.

Parameters:

user - Application user

id - id of the priority scheme to get.

Returns:

ServiceOutcome with FieldConfigScheme

getSchemes

ServiceOutcome<Collection<FieldConfigScheme>> getSchemes(@Nonnull
                                                         ApplicationUser user)

Gets all priority schemes.

Parameters:

user - Application user

Returns:

ServiceOutcome with collection of FieldConfigScheme

schemeDataValidate

ServiceResult schemeDataValidate(ApplicationUser user,
                                 PrioritySchemeService.PrioritySchemeData prioritySchemeData)

Validates if passed PrioritySchemeService.PrioritySchemeData can be used to create/edit priority scheme.

Parameters:

user - Application user

prioritySchemeData -

Returns:

result of validation

getSchemeForProject

ServiceOutcome<FieldConfigScheme> getSchemeForProject(@Nonnull
                                                      ApplicationUser user,
                                                      @Nonnull
                                                      io.atlassian.fugue.Either<Long,String> projectKeyOrId)

Gets the scheme for given project key. User has to have either global administrator permission or be project admin for passed project.

Parameters:

user - Application user

projectKeyOrId - key or id of the project to get scheme for.

Returns:

ServiceOutcome with FieldConfigScheme associated with provided project

filterProjectsNotPossibleToAssociate

List<Project> filterProjectsNotPossibleToAssociate(List<Project> projects)

Filters out projects which shouldn't be associated to priority scheme (e.g. Service Desk projects)

Parameters:

projects - projects to be filtered

Returns:

filtered list of projects

hasAnyNotPossibleToAssociateProject

boolean hasAnyNotPossibleToAssociateProject(Collection<Project> projects)

Checks if in given list there is at least one not able to associate project (e.g. Service Desk project)

Parameters:

projects - list of projects

Returns:

true if there is at least one project which we can't associate to priority scheme. False otherwise.