org.riotfamily.riot.dao
Interface ListParams

All Known Implementing Classes:

EmptyListParams, ListParamsImpl

public interface ListParams

Method Summary

Object	getFilter() Returns an object populated by the list's filter-form, or null if the list does not have a filter.
String[]	getFilteredProperties() Returns the names of all properties bound to the filter-form, or null if the list does not have a filter.
int	getOffset() Returns the offset (starting at 0) of the first object that should be displayed.
List<Order>	getOrder() Returns a list of Order objects that should be used to sort the list.
int	getPageSize() Returns the maximum number of objects that should be displayed on a page.
String	getSearch() Returns the String that should be used to perform a full-text search, or null if no search should be performed.
String[]	getSearchProperties() Returns the name of all properties that should be included in the full-text search, or null if searching is disabled.
boolean	hasOrder() Returns whether sort-order was specified.

Method Detail

getFilter

Object getFilter()

Returns an object populated by the list's filter-form, or null if the list does not have a filter.

getFilteredProperties

String[] getFilteredProperties()

Returns the names of all properties bound to the filter-form, or null if the list does not have a filter.

Since:

6.4

getSearch

String getSearch()

Returns the String that should be used to perform a full-text search, or null if no search should be performed.

Since:

6.4

getSearchProperties

String[] getSearchProperties()

Returns the name of all properties that should be included in the full-text search, or null if searching is disabled.

Since:

6.4

hasOrder

boolean hasOrder()

Returns whether sort-order was specified.

getOrder

List<Order> getOrder()

Returns a list of Order objects that should be used to sort the list.

getPageSize

int getPageSize()

Returns the maximum number of objects that should be displayed on a page.

getOffset

int getOffset()

Returns the offset (starting at 0) of the first object that should be displayed.