Package com.atlassian.jira.project

Class DefaultProjectOrderByManager

java.lang.Object

com.atlassian.jira.project.DefaultProjectOrderByManager

All Implemented Interfaces:

ProjectOrderByManager

public class DefaultProjectOrderByManager
extends Object
implements ProjectOrderByManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFERRED_ORDER_BY_OPTION_KEY

Constructor Summary

Constructors

Constructor	Description
DefaultProjectOrderByManager(ProjectManager projectManager, PermissionManager permissionManager, ProjectPropertiesManager projectPropertiesManager, FieldManager fieldManager, InternalProjectPermissionHelper internalProjectPermissionHelper)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getProjectPreferredOrderByOption(long projectId, ApplicationUser user)	Retrieves the preferred order-by option for issues within a specified project.
void	updateProjectPreferredOrderByOption(long projectId, ApplicationUser user, String newOrderByOption)	Updates the order-by preferences for issues within a specified project.

Methods inherited from class java.lang.Object

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

Field Details

PREFERRED_ORDER_BY_OPTION_KEY

public static final String PREFERRED_ORDER_BY_OPTION_KEY

See Also:

• Constant Field Values

Constructor Details

DefaultProjectOrderByManager

public DefaultProjectOrderByManager(ProjectManager projectManager,
 PermissionManager permissionManager,
 ProjectPropertiesManager projectPropertiesManager,
 FieldManager fieldManager,
 InternalProjectPermissionHelper internalProjectPermissionHelper)

Method Details

getProjectPreferredOrderByOption

public Optional<String> getProjectPreferredOrderByOption(long projectId,
 ApplicationUser user)
                                                  throws PermissionException

Description copied from interface: ProjectOrderByManager

Retrieves the preferred order-by option for issues within a specified project.

If the project is not valid, this method will throw an exception.

If the user lacks permission to browse the project, this method will throw a PermissionException.

Specified by:

getProjectPreferredOrderByOption in interface ProjectOrderByManager

Parameters:

projectId - the ID of the project

user - the user performing the operation

Returns:

an Optional containing the preferred order-by option if available and valid, otherwise Optional.empty()

Throws:

PermissionException - if the user does not have permission to browse the project

updateProjectPreferredOrderByOption

public void updateProjectPreferredOrderByOption(long projectId,
 ApplicationUser user,
 String newOrderByOption)
                                         throws PermissionException

Description copied from interface: ProjectOrderByManager

Updates the order-by preferences for issues within a specified project.

The newOrderByOption specifies the ID of the preferred orderable field. If the newOrderByOption is empty, the preferred order-by option is cleared.

This method will throw exceptions under the following conditions:

• If the project is not valid.
• If the user does not have project administration or admin permissions.
• If the newOrderByOption is invalid.

Specified by:

updateProjectPreferredOrderByOption in interface ProjectOrderByManager

Parameters:

projectId - the ID of the project for which the order-by preferences will be changed

user - the user performing the operation

newOrderByOption - the new preferred order-by option

Throws:

PermissionException - if the user lacks the necessary permissions