com.atlassian.jira.plugin.searchrequestview

Class SearchRequestParamsImpl

java.lang.Object

com.atlassian.jira.plugin.searchrequestview.SearchRequestParamsImpl

All Implemented Interfaces:

IssueViewRequestParams, SearchRequestParams

public class SearchRequestParamsImpl
extends Object
implements SearchRequestParams

Default implmentation of @see com.atlassian.jira.plugin.searchrequestview.SearchRequestParams.

Constructor Summary

Constructors

Constructor and Description
SearchRequestParamsImpl(javax.servlet.http.HttpSession session, PagerFilter pagerFilter, Map<String,?> otherParams, IssueViewFieldParams issueViewFieldParams, String userAgent, String fileExtension)

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	convertSessionToMap(javax.servlet.http.HttpSession session)
String	getFileExtension()
IssueViewFieldParams	getIssueViewFieldParams()
PagerFilter	getPagerFilter() Used to get a handle on a pager filter that will have its start and max values setup based on either system defaults or possibly overridden by request parameters ('tempMax' and 'pager/start').
Map<String,Object>	getSession() Used to access information that may have been stored in the HttpSession.
String	getUserAgent()
boolean	isReturnMax()
void	setReturnMax(boolean returnMax)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRequestParamsImpl

public SearchRequestParamsImpl(javax.servlet.http.HttpSession session,
                               PagerFilter pagerFilter,
                               Map<String,?> otherParams,
                               IssueViewFieldParams issueViewFieldParams,
                               String userAgent,
                               String fileExtension)

Method Detail

convertSessionToMap

public static Map<String,Object> convertSessionToMap(javax.servlet.http.HttpSession session)

getSession

public Map<String,Object> getSession()

Description copied from interface: SearchRequestParams

Used to access information that may have been stored in the HttpSession. Values stored in the session cannot be modified in any way.

Specified by:

getSession in interface SearchRequestParams

Returns:

map containing a shallow copy of the HttpSession

getPagerFilter

public PagerFilter getPagerFilter()

Description copied from interface: SearchRequestParams

Used to get a handle on a pager filter that will have its start and max values setup based on either system defaults or possibly overridden by request parameters ('tempMax' and 'pager/start').

Specified by:

getPagerFilter in interface SearchRequestParams

Returns:

PagerFilter with appropriate max and start values set.

getUserAgent

public String getUserAgent()

Specified by:

getUserAgent in interface SearchRequestParams

Returns:

the user agent string from the request

getIssueViewFieldParams

public IssueViewFieldParams getIssueViewFieldParams()

Specified by:

getIssueViewFieldParams in interface IssueViewRequestParams

setReturnMax

public void setReturnMax(boolean returnMax)

Specified by:

setReturnMax in interface SearchRequestParams

Parameters:

returnMax - true if the search should return up to the maximum number of issues configured for the 'jira.search.views.max.limit' application property, even if a greater value is set as the max on the pager filter.

isReturnMax

public boolean isReturnMax()

Specified by:

isReturnMax in interface SearchRequestParams

Returns:

true if the search should return up to the maximum number of issues configured for the 'jira.search.views.max.limit' application property, even if a greater value is set as the max on the pager filter.

getFileExtension

public String getFileExtension()

Specified by:

getFileExtension in interface SearchRequestParams

Returns:

Desired file extension for attachment.