org.opencms.widgets.dataview

Class CmsDataViewQuery

java.lang.Object

org.opencms.widgets.dataview.CmsDataViewQuery

public class CmsDataViewQuery
extends java.lang.Object

Represents a search query which can be submitted to an implementation of I_CmsDataView to retrieve a set of results.

Constructor Summary

Constructors

Constructor and Description
CmsDataViewQuery()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getFilterValues() Gets the selected filter values.
java.lang.String	getFullTextQuery() Gets the full text query.
java.lang.String	getSortColumn() Gets the column to sort by.
boolean	isSortAscending() Returns true if the sorting for the given sort column should be in ascending order.
void	setFilterValues(java.util.LinkedHashMap<java.lang.String,java.lang.String> filterValues) Sets the selected filter values.
void	setFullTextQuery(java.lang.String query) Sets the full text query.
void	setSortAscending(boolean ascending) Sets the sort direction.
void	setSortColumn(java.lang.String sortColumn) Sets the sort column.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsDataViewQuery

public CmsDataViewQuery()

Method Detail

getFilterValues

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

Gets the selected filter values.

Returns:

the selected filter values

getFullTextQuery

public java.lang.String getFullTextQuery()

Gets the full text query.

If no full text query is provided, this will return the empty string.

Returns:

the full text query

getSortColumn

public java.lang.String getSortColumn()

Gets the column to sort by.

If this method returns null, unsorted results should be returned.

Returns:

the column to sort by

isSortAscending

public boolean isSortAscending()

Returns true if the sorting for the given sort column should be in ascending order.

Returns:

true if the results should be sorted in ascending order

setFilterValues

public void setFilterValues(java.util.LinkedHashMap<java.lang.String,java.lang.String> filterValues)

Sets the selected filter values.

Parameters:

filterValues - the filter values

setFullTextQuery

public void setFullTextQuery(java.lang.String query)

Sets the full text query.

Parameters:

query - the full text query

setSortAscending

public void setSortAscending(boolean ascending)

Sets the sort direction.

Parameters:

ascending - true if results should be sorted in ascending order

setSortColumn

public void setSortColumn(java.lang.String sortColumn)

Sets the sort column.

Parameters:

sortColumn - the sort column