com.liferay.portal.kernel.dao.search

Class SearchContainer<R>

java.lang.Object

com.liferay.portal.kernel.dao.search.SearchContainer<R>

public class SearchContainer<R>
extends java.lang.Object

Author:

Brian Wing Shun Chan

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CUR
static java.lang.String	DEFAULT_CUR_PARAM
static int	DEFAULT_DELTA
static boolean	DEFAULT_DELTA_CONFIGURABLE
static java.lang.String	DEFAULT_DELTA_PARAM
static java.lang.String	DEFAULT_DEPRECATED_TOTAL_VAR
static boolean	DEFAULT_FORCE_POST
static java.lang.String	DEFAULT_ORDER_BY_COL_PARAM
static java.lang.String	DEFAULT_ORDER_BY_TYPE_PARAM
static java.lang.String	DEFAULT_RESULTS_VAR
static java.lang.String	DEFAULT_TOTAL_VAR
static java.lang.String	DEFAULT_VAR
static int	MAX_DELTA

Constructor Summary

Constructors

Constructor and Description
SearchContainer()
SearchContainer(javax.portlet.PortletRequest portletRequest, DisplayTerms displayTerms, DisplayTerms searchTerms, java.lang.String curParam, int cur, int delta, javax.portlet.PortletURL iteratorURL, java.util.List<java.lang.String> headerNames, java.lang.String emptyResultsMessage)
SearchContainer(javax.portlet.PortletRequest portletRequest, DisplayTerms displayTerms, DisplayTerms searchTerms, java.lang.String curParam, int cur, int delta, javax.portlet.PortletURL iteratorURL, java.util.List<java.lang.String> headerNames, java.lang.String emptyResultsMessage, java.lang.String cssClass)
SearchContainer(javax.portlet.PortletRequest portletRequest, DisplayTerms displayTerms, DisplayTerms searchTerms, java.lang.String curParam, int delta, javax.portlet.PortletURL iteratorURL, java.util.List<java.lang.String> headerNames, java.lang.String emptyResultsMessage)
SearchContainer(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletURL iteratorURL, java.util.List<java.lang.String> headerNames, java.lang.String emptyResultsMessage)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName()
java.lang.String	getCssClass()
int	getCur()
java.lang.String	getCurParam()
int	getDelta()
java.lang.String	getDeltaParam()
DisplayTerms	getDisplayTerms()
java.lang.String	getEmptyResultsMessage()
java.lang.String	getEmptyResultsMessageCssClass()
int	getEnd()
java.util.List<java.lang.String>	getHeaderNames()
java.util.Map<java.lang.String,java.lang.String>	getHelpMessages()
java.lang.String	getId(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String namespace)
javax.portlet.PortletURL	getIteratorURL()
java.util.List<java.lang.String>	getNormalizedHeaderNames()
java.util.Map<java.lang.String,java.lang.String>	getOrderableHeaders()
java.lang.String	getOrderByCol()
java.lang.String	getOrderByColParam()
OrderByComparator<R>	getOrderByComparator()
java.lang.String	getOrderByJS()
java.lang.String	getOrderByType()
java.lang.String	getOrderByTypeParam()
javax.portlet.PortletRequest	getPortletRequest()
int	getResultEnd()
java.util.List<ResultRow>	getResultRows()
java.util.List<R>	getResults()
RowChecker	getRowChecker()
RowMover	getRowMover()
DisplayTerms	getSearchTerms()
int	getStart()
java.lang.String	getSummary()
int	getTotal()
java.lang.String	getTotalVar()
boolean	hasResults()
boolean	isDeltaConfigurable()
boolean	isForcePost()
boolean	isHover()
boolean	isRecalculateCur()
boolean	isSearch()
void	setClassName(java.lang.String className)
void	setCssClass(java.lang.String cssClass)
void	setDelta(int delta)
void	setDeltaConfigurable(boolean deltaConfigurable)
void	setDeltaParam(java.lang.String deltaParam)
void	setEmptyResultsMessage(java.lang.String emptyResultsMessage)
void	setEmptyResultsMessageCssClass(java.lang.String emptyResultsMessageCssClass)
void	setForcePost(boolean forcePost)
void	setHeaderNames(java.util.List<java.lang.String> headerNames)
void	setHelpMessages(java.util.Map<java.lang.String,java.lang.String> helpMessages)
void	setHover(boolean hover)
void	setId(java.lang.String id)
void	setIteratorURL(javax.portlet.PortletURL iteratorURL)
void	setOrderableHeaders(java.util.Map<java.lang.String,java.lang.String> orderableHeaders)
void	setOrderByCol(java.lang.String orderByCol)
void	setOrderByColParam(java.lang.String orderByColParam)
void	setOrderByComparator(OrderByComparator<R> orderByComparator)
void	setOrderByJS(java.lang.String orderByJS)
void	setOrderByType(java.lang.String orderByType)
void	setOrderByTypeParam(java.lang.String orderByTypeParam)
void	setResults(java.util.List<R> results)
void	setRowChecker(RowChecker rowChecker)
void	setRowMover(RowMover rowMover)
void	setSearch(boolean search)
void	setSummary(java.lang.String summary)
void	setTotal(int total)
void	setTotalVar(java.lang.String totalVar)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CUR

public static final int DEFAULT_CUR

See Also:

Constant Field Values

DEFAULT_CUR_PARAM

public static final java.lang.String DEFAULT_CUR_PARAM

See Also:

Constant Field Values

DEFAULT_DELTA

public static final int DEFAULT_DELTA

DEFAULT_DELTA_CONFIGURABLE

public static final boolean DEFAULT_DELTA_CONFIGURABLE

See Also:

Constant Field Values

DEFAULT_DELTA_PARAM

public static final java.lang.String DEFAULT_DELTA_PARAM

See Also:

Constant Field Values

DEFAULT_DEPRECATED_TOTAL_VAR

public static final java.lang.String DEFAULT_DEPRECATED_TOTAL_VAR

See Also:

Constant Field Values

DEFAULT_FORCE_POST

public static final boolean DEFAULT_FORCE_POST

See Also:

Constant Field Values

DEFAULT_ORDER_BY_COL_PARAM

public static final java.lang.String DEFAULT_ORDER_BY_COL_PARAM

See Also:

Constant Field Values

DEFAULT_ORDER_BY_TYPE_PARAM

public static final java.lang.String DEFAULT_ORDER_BY_TYPE_PARAM

See Also:

Constant Field Values

DEFAULT_RESULTS_VAR

public static final java.lang.String DEFAULT_RESULTS_VAR

See Also:

Constant Field Values

DEFAULT_TOTAL_VAR

public static final java.lang.String DEFAULT_TOTAL_VAR

See Also:

Constant Field Values

DEFAULT_VAR

public static final java.lang.String DEFAULT_VAR

See Also:

Constant Field Values

MAX_DELTA

public static final int MAX_DELTA

See Also:

Constant Field Values

Constructor Detail

SearchContainer

public SearchContainer()

SearchContainer

public SearchContainer(javax.portlet.PortletRequest portletRequest,
                       DisplayTerms displayTerms,
                       DisplayTerms searchTerms,
                       java.lang.String curParam,
                       int cur,
                       int delta,
                       javax.portlet.PortletURL iteratorURL,
                       java.util.List<java.lang.String> headerNames,
                       java.lang.String emptyResultsMessage)

SearchContainer

public SearchContainer(javax.portlet.PortletRequest portletRequest,
                       DisplayTerms displayTerms,
                       DisplayTerms searchTerms,
                       java.lang.String curParam,
                       int cur,
                       int delta,
                       javax.portlet.PortletURL iteratorURL,
                       java.util.List<java.lang.String> headerNames,
                       java.lang.String emptyResultsMessage,
                       java.lang.String cssClass)

SearchContainer

public SearchContainer(javax.portlet.PortletRequest portletRequest,
                       DisplayTerms displayTerms,
                       DisplayTerms searchTerms,
                       java.lang.String curParam,
                       int delta,
                       javax.portlet.PortletURL iteratorURL,
                       java.util.List<java.lang.String> headerNames,
                       java.lang.String emptyResultsMessage)

SearchContainer

public SearchContainer(javax.portlet.PortletRequest portletRequest,
                       javax.portlet.PortletURL iteratorURL,
                       java.util.List<java.lang.String> headerNames,
                       java.lang.String emptyResultsMessage)

Method Detail

getClassName

public java.lang.String getClassName()

getCssClass

public java.lang.String getCssClass()

getCur

public int getCur()

getCurParam

public java.lang.String getCurParam()

getDelta

public int getDelta()

getDeltaParam

public java.lang.String getDeltaParam()

getDisplayTerms

public DisplayTerms getDisplayTerms()

getEmptyResultsMessage

public java.lang.String getEmptyResultsMessage()

getEmptyResultsMessageCssClass

public java.lang.String getEmptyResultsMessageCssClass()

getEnd

public int getEnd()

getHeaderNames

public java.util.List<java.lang.String> getHeaderNames()

getHelpMessages

public java.util.Map<java.lang.String,java.lang.String> getHelpMessages()

getId

public java.lang.String getId(javax.servlet.http.HttpServletRequest httpServletRequest,
                              java.lang.String namespace)

getIteratorURL

public javax.portlet.PortletURL getIteratorURL()

getNormalizedHeaderNames

public java.util.List<java.lang.String> getNormalizedHeaderNames()

getOrderableHeaders

public java.util.Map<java.lang.String,java.lang.String> getOrderableHeaders()

getOrderByCol

public java.lang.String getOrderByCol()

getOrderByColParam

public java.lang.String getOrderByColParam()

getOrderByComparator

public OrderByComparator<R> getOrderByComparator()

getOrderByJS

public java.lang.String getOrderByJS()

getOrderByType

public java.lang.String getOrderByType()

getOrderByTypeParam

public java.lang.String getOrderByTypeParam()

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

getResultEnd

public int getResultEnd()

getResultRows

public java.util.List<ResultRow> getResultRows()

getResults

public java.util.List<R> getResults()

getRowChecker

public RowChecker getRowChecker()

getRowMover

public RowMover getRowMover()

getSearchTerms

public DisplayTerms getSearchTerms()

getStart

public int getStart()

getSummary

public java.lang.String getSummary()

getTotal

public int getTotal()

getTotalVar

public java.lang.String getTotalVar()

hasResults

public boolean hasResults()

isDeltaConfigurable

public boolean isDeltaConfigurable()

isForcePost

public boolean isForcePost()

isHover

public boolean isHover()

isRecalculateCur

public boolean isRecalculateCur()

isSearch

public boolean isSearch()

setClassName

public void setClassName(java.lang.String className)

setCssClass

public void setCssClass(java.lang.String cssClass)

setDelta

public void setDelta(int delta)

setDeltaConfigurable

public void setDeltaConfigurable(boolean deltaConfigurable)

setDeltaParam

public void setDeltaParam(java.lang.String deltaParam)

setEmptyResultsMessage

public void setEmptyResultsMessage(java.lang.String emptyResultsMessage)

setEmptyResultsMessageCssClass

public void setEmptyResultsMessageCssClass(java.lang.String emptyResultsMessageCssClass)

setForcePost

public void setForcePost(boolean forcePost)

setHeaderNames

public void setHeaderNames(java.util.List<java.lang.String> headerNames)

setHelpMessages

public void setHelpMessages(java.util.Map<java.lang.String,java.lang.String> helpMessages)

setHover

public void setHover(boolean hover)

setId

public void setId(java.lang.String id)

setIteratorURL

public void setIteratorURL(javax.portlet.PortletURL iteratorURL)

setOrderableHeaders

public void setOrderableHeaders(java.util.Map<java.lang.String,java.lang.String> orderableHeaders)

setOrderByCol

public void setOrderByCol(java.lang.String orderByCol)

setOrderByColParam

public void setOrderByColParam(java.lang.String orderByColParam)

setOrderByComparator

public void setOrderByComparator(OrderByComparator<R> orderByComparator)

setOrderByJS

public void setOrderByJS(java.lang.String orderByJS)

setOrderByType

public void setOrderByType(java.lang.String orderByType)

setOrderByTypeParam

public void setOrderByTypeParam(java.lang.String orderByTypeParam)

setResults

public void setResults(java.util.List<R> results)

setRowChecker

public void setRowChecker(RowChecker rowChecker)

setRowMover

public void setRowMover(RowMover rowMover)

setSearch

public void setSearch(boolean search)

setSummary

public void setSummary(java.lang.String summary)

setTotal

public void setTotal(int total)

setTotalVar

public void setTotalVar(java.lang.String totalVar)