Package com.atlassian.jira.rest.internal.v2.project

Class ProjectPreferencesResource

java.lang.Object

com.atlassian.jira.rest.internal.v2.project.ProjectPreferencesResource

@Path("project-preferences")
@Produces("application/json")
@Consumes("application/json")
public class ProjectPreferencesResource
extends Object

Constructor Summary

Constructors

Constructor	Description
ProjectPreferencesResource(ProjectOrderByManager projectOrderByManager, JiraAuthenticationContext authContext)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	collectOrderByPreferences(long projectId)	Retrieves order-by preferences for a specified project.
jakarta.ws.rs.core.Response	saveOrderByPreferences(OrderByPreferences orderByPreferences)	Handles the saving of order-by preferences for a given project.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectPreferencesResource

@Inject
public ProjectPreferencesResource(ProjectOrderByManager projectOrderByManager,
 JiraAuthenticationContext authContext)

Method Details

saveOrderByPreferences

@POST
public jakarta.ws.rs.core.Response saveOrderByPreferences(OrderByPreferences orderByPreferences)

Handles the saving of order-by preferences for a given project. This endpoint processes an OrderByPreferences object that contains order-by preferences and project ID. If the OrderByPreferences object is null, a 400 Bad Request status is returned. Upon a successful save operation, the method returns a 200 OK status. If an error occurs during the operation, a PermissionException or an IllegalArgumentException is thrown, resulting in a 403 Forbidden or 400 Bad Request status.

Parameters:

orderByPreferences - the order-by preferences to be saved

Returns:

Response indicating the success or failure of the save operation

collectOrderByPreferences

@GET
@Path("/{projectId}")
public jakarta.ws.rs.core.Response collectOrderByPreferences(@PathParam("projectId")
 long projectId)

Retrieves order-by preferences for a specified project. On successful retrieval, the method returns a 200 OK status along with the order-by preferences as a String. If an error occurs during the retrieval process, a PermissionException or an IllegalArgumentException is thrown with details about the error and the project ID.

Parameters:

projectId - ID of the project for which we want to collect order-by preferences

Returns:

Response containing the order-by preferences or an error status