Package com.atlassian.jira.issue.fields.config

Class DefaultPrioritySchemeService

java.lang.Object

com.atlassian.jira.issue.fields.config.DefaultPrioritySchemeService

All Implemented Interfaces:

PrioritySchemeService

public class DefaultPrioritySchemeService
extends Object
implements PrioritySchemeService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.issue.fields.config.PrioritySchemeService

PrioritySchemeService.PrioritySchemeData

Field Summary

Fields

Modifier and Type	Field	Description
static final ProjectAction	PROJECT_ACTION_PERMISSION

Constructor Summary

Constructors

Constructor	Description
DefaultPrioritySchemeService(GlobalPermissionManager globalPermissionManager, PrioritySchemeManager prioritySchemeManager, ProjectService projectService, I18nHelper i18nHelper, PrioritySchemeMigratorFinder prioritySchemeMigratorFinder, FeatureManager featureManager)

Method Summary

Modifier and Type	Method	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 blockMigration)	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<Set<Priority>>	getSchemeOptionsForProject(ApplicationUser user, io.atlassian.fugue.Either<Long,String> projectKeyOrId)	Returns collection of priorities configured in given project's scheme User has to have com.atlassian.jira.bc.project.ProjectAction.VIEW_PROJECT permission
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.

Methods inherited from class java.lang.Object

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

Field Details

PROJECT_ACTION_PERMISSION

public static final ProjectAction PROJECT_ACTION_PERMISSION

Constructor Details

DefaultPrioritySchemeService

public DefaultPrioritySchemeService(GlobalPermissionManager globalPermissionManager,
 PrioritySchemeManager prioritySchemeManager,
 ProjectService projectService,
 I18nHelper i18nHelper,
 PrioritySchemeMigratorFinder prioritySchemeMigratorFinder,
 FeatureManager featureManager)

Method Details

assignProjects

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

Description copied from interface: PrioritySchemeService

Associates projects with a priority scheme.

Specified by:

assignProjects in interface PrioritySchemeService

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

Throws:

NoPermissionException

assignProject

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

Description copied from interface: PrioritySchemeService

Associates a project with a priority scheme.

Specified by:

assignProject in interface PrioritySchemeService

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

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

Description copied from interface: PrioritySchemeService

Associates a project with a priority scheme.

Specified by:

assignProject in interface PrioritySchemeService

Parameters:

user - Application user

schemeId - id of the priority scheme.

projectKeyOrId - key of id of the project

blockMigration - whether validation should fail if migration is needed

Returns:

ServiceOutcome with affected FieldConfigScheme

unassignProject

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

Description copied from interface: PrioritySchemeService

Deassociates a project from a priority scheme.

Specified by:

unassignProject in interface PrioritySchemeService

Parameters:

user - Application user

schemeId - id of the priority scheme.

projectKeyOrId - key or id of the project

Returns:

ServiceOutcome with affected FieldConfigScheme

editScheme

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

Description copied from interface: PrioritySchemeService

Updates the scheme wih given data.

Specified by:

editScheme in interface PrioritySchemeService

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

Throws:

NoPermissionException

editScheme

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

Description copied from interface: PrioritySchemeService

Updates the scheme wih given data.

Specified by:

editScheme in interface PrioritySchemeService

Parameters:

user - Application user

data - priority scheme data

failIfMigrationNeeded - whether validation should fail if migration is needed

Returns:

ServiceOutcome with affected FieldConfigScheme

deleteScheme

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

Description copied from interface: PrioritySchemeService

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

Specified by:

deleteScheme in interface PrioritySchemeService

Parameters:

user - Application user

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

Returns:

result of operation

deleteScheme

public ServiceResult deleteScheme(@Nonnull
 ApplicationUser user,
 @Nonnull
 FieldConfigScheme priorityFieldConfig)
                           throws NoPermissionException

Description copied from interface: PrioritySchemeService

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

Specified by:

deleteScheme in interface PrioritySchemeService

Parameters:

user - Application user

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

Returns:

result of operation

Throws:

NoPermissionException

createScheme

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

Description copied from interface: PrioritySchemeService

Creates the scheme wih given data.

Specified by:

createScheme in interface PrioritySchemeService

Parameters:

user - Application user

prioritySchemeData - data of the priority scheme to create.

Returns:

ServiceOutcome with newly created FieldConfigScheme

schemeDataValidate

public ServiceResult schemeDataValidate(ApplicationUser user,
 PrioritySchemeService.PrioritySchemeData prioritySchemeData)

Description copied from interface: PrioritySchemeService

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

Specified by:

schemeDataValidate in interface PrioritySchemeService

Parameters:

user - Application user

Returns:

result of validation

getScheme

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

Description copied from interface: PrioritySchemeService

Gets the scheme wih given id.

Specified by:

getScheme in interface PrioritySchemeService

Parameters:

user - Application user

id - id of the priority scheme to get.

Returns:

ServiceOutcome with FieldConfigScheme

getSchemes

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

Description copied from interface: PrioritySchemeService

Gets all priority schemes.

Specified by:

getSchemes in interface PrioritySchemeService

Parameters:

user - Application user

Returns:

ServiceOutcome with collection of FieldConfigScheme

getSchemeForProject

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

Description copied from interface: PrioritySchemeService

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

Specified by:

getSchemeForProject in interface PrioritySchemeService

Parameters:

user - Application user

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

Returns:

ServiceOutcome with FieldConfigScheme associated with provided project

getSchemeOptionsForProject

public ServiceOutcome<Set<Priority>> getSchemeOptionsForProject(@Nonnull
 ApplicationUser user,
 @Nonnull
 io.atlassian.fugue.Either<Long,String> projectKeyOrId)

Description copied from interface: PrioritySchemeService

Returns collection of priorities configured in given project's scheme User has to have com.atlassian.jira.bc.project.ProjectAction.VIEW_PROJECT permission

Specified by:

getSchemeOptionsForProject in interface PrioritySchemeService

Parameters:

user - ApplicationUser current user

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

Returns:

ServiceOutcome with Set of Priority associated with provided project

filterProjectsNotPossibleToAssociate

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

Description copied from interface: PrioritySchemeService

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

Specified by:

filterProjectsNotPossibleToAssociate in interface PrioritySchemeService

Parameters:

projects - projects to be filtered

Returns:

filtered list of projects

hasAnyNotPossibleToAssociateProject

public boolean hasAnyNotPossibleToAssociateProject(Collection<Project> projects)

Description copied from interface: PrioritySchemeService

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

Specified by:

hasAnyNotPossibleToAssociateProject in interface PrioritySchemeService

Parameters:

projects - list of projects

Returns:

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