ch.ralscha.extdirectspring.bean

Class ExtDirectStoreReadRequest

java.lang.Object

ch.ralscha.extdirectspring.bean.ExtDirectStoreReadRequest

public class ExtDirectStoreReadRequest
extends Object

Represents the request of a DirectStore read call.

Constructor Summary

Constructors

Constructor and Description
ExtDirectStoreReadRequest()

Method Summary

Methods

Modifier and Type	Method and Description
List<Filter>	getAllFiltersForField(String field) Returns all filters for a field
String	getDir()
List<Filter>	getFilters()
<T extends Filter> T	getFirstFilterForField(String field) Returns the first filter for the field.
String	getGroupBy()
String	getGroupDir()
List<GroupInfo>	getGroups()
Integer	getLimit()
Integer	getPage()
Map<String,Object>	getParams()
String	getQuery()
String	getSort()
List<SortInfo>	getSorters()
Integer	getStart()
boolean	isAscendingGroupSort()
boolean	isAscendingSort()
boolean	isDescendingGroupSort()
boolean	isDescendingSort()
void	setDir(String dir)
void	setFilters(List<Filter> filters)
void	setGroupBy(String groupBy)
void	setGroupDir(String groupDir)
void	setGroups(List<GroupInfo> groups)
void	setLimit(Integer limit)
void	setPage(Integer page)
void	setParams(Map<String,Object> params)
void	setQuery(String query)
void	setSort(String sort)
void	setSorters(List<SortInfo> sorters)
void	setStart(Integer start)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtDirectStoreReadRequest

public ExtDirectStoreReadRequest()

Method Detail

getQuery

public String getQuery()

Returns:

the text a user entered into a combobox with queryMode 'remote'

setQuery

public void setQuery(String query)

getLimit

public Integer getLimit()

Returns:

the number of rows the DirectStore requests for paging

setLimit

public void setLimit(Integer limit)

getStart

public Integer getStart()

Returns:

the start row from where to send records back for a paging request. start = getLimit() * (getPage()-1)

setStart

public void setStart(Integer start)

getDir

public String getDir()

Returns:

sorting order. "ASC" or "DESC".
Ext JS 4.x and Touch 2 can send more than one sorters. Use getSorters() instead.

See Also:

isAscendingSort(), isDescendingSort()

setDir

public void setDir(String dir)

isAscendingSort

public boolean isAscendingSort()

Returns:

true if sorting order is ascending.
Ext JS 4.x and Touch 2 can send more than one sorters. Use getSorters() instead.

isDescendingSort

public boolean isDescendingSort()

Returns:

true if sorting order is descending.
Ext JS 4.x and Touch 2 can send more than one sorters. Use getSorters() instead.

getSort

public String getSort()

Returns:

the field/property on which the sort should be applied.
Ext JS 4.x and Touch 2 can send more than one sorters. Use getSorters() instead.

setSort

public void setSort(String sort)

getGroupBy

public String getGroupBy()

Returns:

the field/property name on which the grouping should occur.
Ext JS 4.x and Touch 2 can send more than one group info. Use getGroups() instead.

setGroupBy

public void setGroupBy(String groupBy)

getGroupDir

public String getGroupDir()

Returns:

sorting order for a grouping request. "ASC" or "DESC".
Ext JS 4.x and Touch 2 can send more than one group info. Use getGroups() instead.

setGroupDir

public void setGroupDir(String groupDir)

isAscendingGroupSort

public boolean isAscendingGroupSort()

Returns:

true if grouping sorting order is ascending.
Ext JS 4.x and Touch 2 can send more than one group info. Use getGroups() instead.

isDescendingGroupSort

public boolean isDescendingGroupSort()

Returns:

true if grouping sorting order is descending.
Ext JS 4.x and Touch 2 can send more than one group info. Use getGroups() instead.

getFilters

public List<Filter> getFilters()

Returns:

collection of filter implementations

See Also:

BooleanFilter, DateFilter, ListFilter, NumericFilter, StringFilter

getFirstFilterForField

public <T extends Filter> T getFirstFilterForField(String field)

Returns the first filter for the field.

Parameters:

field - name of the field

Returns:

the first filter for the field. Null if not filter exists.

getAllFiltersForField

public List<Filter> getAllFiltersForField(String field)

Returns all filters for a field

Parameters:

field - name of the field

Returns:

a collection of filters for the field. Empty collection if no filter exists

setFilters

public void setFilters(List<Filter> filters)

getPage

public Integer getPage()

Returns:

page number of a paging request. page = (getStart() / getLimit()) + 1

setPage

public void setPage(Integer page)

getSorters

public List<SortInfo> getSorters()

setSorters

public void setSorters(List<SortInfo> sorters)

getGroups

public List<GroupInfo> getGroups()

setGroups

public void setGroups(List<GroupInfo> groups)

getParams

public Map<String,Object> getParams()

Returns:

a map with all the keys and values from extraParams

setParams

public void setParams(Map<String,Object> params)

toString

public String toString()

Overrides:

toString in class Object