Package com.atlassian.jira.plugin.issuenav.util

Class PreferredSearchLayoutService

java.lang.Object

com.atlassian.jira.plugin.issuenav.util.PreferredSearchLayoutService

@Named
public class PreferredSearchLayoutService
extends Object

Provides methods to get and set the current user's preferred search layout.

The user's preference is stored in their session and, if they're authenticated, as a user preference.

Since:

v6.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_VIEW_LAYOUT
static final String	PREFERRED_SEARCH_LAYOUT_KEY
static final String	SPLIT_VIEW_LAYOUT

Constructor Summary

Constructors

Constructor	Description
PreferredSearchLayoutService(ActionUtilsService actionUtilsService, JiraAuthenticationContext jiraAuthenticationContext, UserPreferencesManager userPreferencesManager, VelocityRequestContextFactory velocityRequestContextFactory)

Method Summary

Modifier and Type	Method	Description
String	getPreferredSearchLayout()	Retrieve the current user's preferred search layout.
void	setPreferredSearchLayout(String layoutKey)	Set the current user's preferred search layout.

Methods inherited from class java.lang.Object

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

Field Details

LIST_VIEW_LAYOUT

public static final String LIST_VIEW_LAYOUT

See Also:

• Constant Field Values

PREFERRED_SEARCH_LAYOUT_KEY

public static final String PREFERRED_SEARCH_LAYOUT_KEY

See Also:

• Constant Field Values

SPLIT_VIEW_LAYOUT

public static final String SPLIT_VIEW_LAYOUT

See Also:

• Constant Field Values

Constructor Details

PreferredSearchLayoutService

@Inject
public PreferredSearchLayoutService(ActionUtilsService actionUtilsService,
 JiraAuthenticationContext jiraAuthenticationContext,
 UserPreferencesManager userPreferencesManager,
 VelocityRequestContextFactory velocityRequestContextFactory)

Method Details

getPreferredSearchLayout

public String getPreferredSearchLayout()

Retrieve the current user's preferred search layout.

For anonymous users, the default layout is returned.

Returns:

the current user's preferred search layout.

setPreferredSearchLayout

public void setPreferredSearchLayout(String layoutKey)

Set the current user's preferred search layout.

If the current user is anonymous, this method does nothing.

Parameters:

layoutKey - The key of the user's preferred search layout.