Package org.opencms.widgets.dataview

Class CmsDataViewQuery

java.lang.Object
org.opencms.widgets.dataview.CmsDataViewQuery
public class CmsDataViewQuery extends Object
Represents a search query which can be submitted to an implementation of I_CmsDataView to retrieve a set of results.

  • Constructor Details

  • Method Details

    • getFilterValues

      public Map<String,String> getFilterValues()
      Gets the selected filter values.

      Returns:
      the selected filter values

    • getFullTextQuery

      public 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 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(LinkedHashMap<String,String> filterValues)
      Sets the selected filter values.

      Parameters:
      filterValues - the filter values

    • setFullTextQuery

      public void setFullTextQuery(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(String sortColumn)
      Sets the sort column.

      Parameters:
      sortColumn - the sort column