SearchContainer (Liferay 7.2.1-ga2 portal-kernel API)

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

public class SearchContainer<R>
extends Object

Author:: Brian Wing Shun Chan

Field Summary

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

Constructor Summary

Constructors
Constructor and Description
`SearchContainer()`
`SearchContainer(PortletRequest portletRequest, DisplayTerms displayTerms, DisplayTerms searchTerms, String curParam, int cur, int delta, PortletURL iteratorURL, List<String> headerNames, String emptyResultsMessage)`
`SearchContainer(PortletRequest portletRequest, DisplayTerms displayTerms, DisplayTerms searchTerms, String curParam, int cur, int delta, PortletURL iteratorURL, List<String> headerNames, String emptyResultsMessage, String cssClass)`
`SearchContainer(PortletRequest portletRequest, DisplayTerms displayTerms, DisplayTerms searchTerms, String curParam, int delta, PortletURL iteratorURL, List<String> headerNames, String emptyResultsMessage)`
`SearchContainer(PortletRequest portletRequest, PortletURL iteratorURL, List<String> headerNames, String emptyResultsMessage)`

Method Summary

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

Methods inherited from class 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 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 String DEFAULT_DELTA_PARAM
```
  See Also:
  
  Constant Field Values
- DEFAULT_DEPRECATED_TOTAL_VAR
```
public static final 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 String DEFAULT_ORDER_BY_COL_PARAM
```
  See Also:
  
  Constant Field Values
- DEFAULT_ORDER_BY_TYPE_PARAM
```
public static final String DEFAULT_ORDER_BY_TYPE_PARAM
```
  See Also:
  
  Constant Field Values
- DEFAULT_RESULTS_VAR
```
public static final String DEFAULT_RESULTS_VAR
```
  See Also:
  
  Constant Field Values
- DEFAULT_TOTAL_VAR
```
public static final String DEFAULT_TOTAL_VAR
```
  See Also:
  
  Constant Field Values
- DEFAULT_VAR
```
public static final 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(PortletRequest portletRequest,
                       DisplayTerms displayTerms,
                       DisplayTerms searchTerms,
                       String curParam,
                       int cur,
                       int delta,
                       PortletURL iteratorURL,
                       List<String> headerNames,
                       String emptyResultsMessage)

SearchContainer

public SearchContainer(PortletRequest portletRequest,
                       DisplayTerms displayTerms,
                       DisplayTerms searchTerms,
                       String curParam,
                       int cur,
                       int delta,
                       PortletURL iteratorURL,
                       List<String> headerNames,
                       String emptyResultsMessage,
                       String cssClass)

SearchContainer

public SearchContainer(PortletRequest portletRequest,
                       DisplayTerms displayTerms,
                       DisplayTerms searchTerms,
                       String curParam,
                       int delta,
                       PortletURL iteratorURL,
                       List<String> headerNames,
                       String emptyResultsMessage)

SearchContainer

public SearchContainer(PortletRequest portletRequest,
                       PortletURL iteratorURL,
                       List<String> headerNames,
                       String emptyResultsMessage)

Method Detail

getClassName
```
public String getClassName()
```

getCssClass
```
public String getCssClass()
```

getCur
```
public int getCur()
```

getCurParam
```
public String getCurParam()
```

getDelta
```
public int getDelta()
```

getDeltaParam
```
public String getDeltaParam()
```

getDisplayTerms
```
public DisplayTerms getDisplayTerms()
```

getEmptyResultsMessage

public String getEmptyResultsMessage()

getEmptyResultsMessageCssClass

public String getEmptyResultsMessageCssClass()

getEnd
```
public int getEnd()
```

getHeaderNames
```
public List<String> getHeaderNames()
```

getId

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

getIteratorURL
```
public PortletURL getIteratorURL()
```

getNormalizedHeaderNames

public List<String> getNormalizedHeaderNames()

getOrderableHeaders

public Map<String,String> getOrderableHeaders()

getOrderByCol
```
public String getOrderByCol()
```

getOrderByColParam
```
public String getOrderByColParam()
```

getOrderByComparator

public OrderByComparator<R> getOrderByComparator()

getOrderByJS
```
public String getOrderByJS()
```

getOrderByType
```
public String getOrderByType()
```

getOrderByTypeParam
```
public String getOrderByTypeParam()
```

getPortletRequest

public PortletRequest getPortletRequest()

getResultEnd
```
public int getResultEnd()
```

getResultRows

public List<ResultRow> getResultRows()

getResults
```
public List<R> getResults()
```

getRowChecker
```
public RowChecker getRowChecker()
```

getRowMover
```
public RowMover getRowMover()
```

getSearchTerms
```
public DisplayTerms getSearchTerms()
```

getStart
```
public int getStart()
```

getSummary
```
public String getSummary()
```

getTotal
```
public int getTotal()
```

getTotalVar
```
public 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(String className)

setCssClass

public void setCssClass(String cssClass)

setDelta
```
public void setDelta(int delta)
```

setDeltaConfigurable

public void setDeltaConfigurable(boolean deltaConfigurable)

setDeltaParam

public void setDeltaParam(String deltaParam)

setEmptyResultsMessage

public void setEmptyResultsMessage(String emptyResultsMessage)

setEmptyResultsMessageCssClass

public void setEmptyResultsMessageCssClass(String emptyResultsMessageCssClass)

setForcePost

public void setForcePost(boolean forcePost)

setHeaderNames

public void setHeaderNames(List<String> headerNames)

setHover
```
public void setHover(boolean hover)
```

setId
```
public void setId(String id)
```

setIteratorURL

public void setIteratorURL(PortletURL iteratorURL)

setOrderableHeaders

public void setOrderableHeaders(Map<String,String> orderableHeaders)

setOrderByCol

public void setOrderByCol(String orderByCol)

setOrderByColParam

public void setOrderByColParam(String orderByColParam)

setOrderByComparator

public void setOrderByComparator(OrderByComparator<R> orderByComparator)

setOrderByJS

public void setOrderByJS(String orderByJS)

setOrderByType

public void setOrderByType(String orderByType)

setOrderByTypeParam

public void setOrderByTypeParam(String orderByTypeParam)

setResults

public void setResults(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(String summary)

setTotal
```
public void setTotal(int total)
```

setTotalVar

public void setTotalVar(String totalVar)

Class SearchContainer<R>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

DEFAULT_CUR

DEFAULT_CUR_PARAM

DEFAULT_DELTA

DEFAULT_DELTA_CONFIGURABLE

DEFAULT_DELTA_PARAM

DEFAULT_DEPRECATED_TOTAL_VAR

DEFAULT_FORCE_POST

DEFAULT_ORDER_BY_COL_PARAM

DEFAULT_ORDER_BY_TYPE_PARAM

DEFAULT_RESULTS_VAR

DEFAULT_TOTAL_VAR

DEFAULT_VAR

MAX_DELTA

Constructor Detail

SearchContainer

SearchContainer

SearchContainer

SearchContainer

SearchContainer

Method Detail

getClassName

getCssClass

getCur

getCurParam

getDelta

getDeltaParam

getDisplayTerms

getEmptyResultsMessage

getEmptyResultsMessageCssClass

getEnd

getHeaderNames

getId

getIteratorURL

getNormalizedHeaderNames

getOrderableHeaders

getOrderByCol

getOrderByColParam

getOrderByComparator

getOrderByJS

getOrderByType

getOrderByTypeParam

getPortletRequest

getResultEnd

getResultRows

getResults

getRowChecker

getRowMover

getSearchTerms

getStart

getSummary

getTotal

getTotalVar

hasResults

isDeltaConfigurable

isForcePost

isHover

isRecalculateCur

isSearch

setClassName

setCssClass

setDelta

setDeltaConfigurable

setDeltaParam

setEmptyResultsMessage

setEmptyResultsMessageCssClass

setForcePost

setHeaderNames

setHover

setId

setIteratorURL

setOrderableHeaders

setOrderByCol

setOrderByColParam

setOrderByComparator