Class SearchDTO
- java.lang.Object
-
- net.sourceforge.jbizmo.commons.search.dto.SearchDTO
-
- All Implemented Interfaces:
Serializable
public class SearchDTO extends Object implements Serializable
Data transfer object that holds all necessary data for building generic queries
Copyright 2010 (C) by Martin Ganserer
- Version:
- 1.0.0
- Author:
- Martin Ganserer
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SearchDTO()Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetDateFormat()StringgetDateTimeFormat()chargetDecimalSeparator()StringgetFromClause()StringgetGroupBy()chargetGroupingSeparator()intgetId()intgetMaxResult()StringgetNumberFormat()List<SearchFieldDTO>getSearchFields()intgetStartIndex()booleanisCaseSensitive()booleanisCount()booleanisExactFilterMatch()booleanisFetchHidden()voidsetCaseSensitive(boolean caseSensitive)Set the flag to determine if a search should be case sensitivevoidsetCount(boolean count)Set the flag that controls if a count operation should be performedvoidsetDateFormat(String dateFormat)Set the date formatvoidsetDateTimeFormat(String dateTimeFormat)Set the date time formatvoidsetDecimalSeparator(char decimalSeparator)voidsetExactFilterMatch(boolean exactFilterMatch)voidsetFetchHidden(boolean fetchHidden)Set the hidden fetch flagvoidsetFromClause(String fromClause)Set the from clause of the queryvoidsetGroupBy(String groupBy)voidsetGroupingSeparator(char groupingSeparator)voidsetId(int id)voidsetMaxResult(int maxResult)Set the max.voidsetNumberFormat(String numberFormat)Set the number formatvoidsetSearchFields(List<SearchFieldDTO> searchFields)voidsetStartIndex(int startIndex)Set the start index
-
-
-
Method Detail
-
getDateTimeFormat
public String getDateTimeFormat()
- Returns:
- the date time format
-
setDateTimeFormat
public void setDateTimeFormat(String dateTimeFormat)
Set the date time format- Parameters:
dateTimeFormat-
-
getGroupBy
public String getGroupBy()
- Returns:
- the group by statement
-
setGroupBy
public void setGroupBy(String groupBy)
- Parameters:
groupBy-
-
getFromClause
public String getFromClause()
- Returns:
- the from clause
-
setFromClause
public void setFromClause(String fromClause)
Set the from clause of the query- Parameters:
fromClause-
-
isCaseSensitive
public boolean isCaseSensitive()
- Returns:
- true if the search should be case sensitive
-
setCaseSensitive
public void setCaseSensitive(boolean caseSensitive)
Set the flag to determine if a search should be case sensitive- Parameters:
caseSensitive-
-
getDateFormat
public String getDateFormat()
- Returns:
- the date format that is used
-
setDateFormat
public void setDateFormat(String dateFormat)
Set the date format- Parameters:
dateFormat-
-
getMaxResult
public int getMaxResult()
- Returns:
- the max. number of results
-
setMaxResult
public void setMaxResult(int maxResult)
Set the max. number of objects a query should return- Parameters:
maxResult-
-
getNumberFormat
public String getNumberFormat()
- Returns:
- the number format
-
setNumberFormat
public void setNumberFormat(String numberFormat)
Set the number format- Parameters:
numberFormat-
-
getSearchFields
public List<SearchFieldDTO> getSearchFields()
- Returns:
- the search fields
-
setSearchFields
public void setSearchFields(List<SearchFieldDTO> searchFields)
- Parameters:
searchFields- the search fields to set
-
isCount
public boolean isCount()
- Returns:
- true if the service should perform a count operation
-
setCount
public void setCount(boolean count)
Set the flag that controls if a count operation should be performed- Parameters:
count-
-
isFetchHidden
public boolean isFetchHidden()
- Returns:
- true if hidden fields should be fetched
-
setFetchHidden
public void setFetchHidden(boolean fetchHidden)
Set the hidden fetch flag- Parameters:
fetchHidden-
-
getStartIndex
public int getStartIndex()
- Returns:
- the start index
-
setStartIndex
public void setStartIndex(int startIndex)
Set the start index- Parameters:
startIndex-
-
isExactFilterMatch
public boolean isExactFilterMatch()
- Returns:
- true if an exact filter match is expected
-
setExactFilterMatch
public void setExactFilterMatch(boolean exactFilterMatch)
- Parameters:
exactFilterMatch-
-
getId
public int getId()
- Returns:
- the ID
-
setId
public void setId(int id)
- Parameters:
id-
-
getDecimalSeparator
public char getDecimalSeparator()
- Returns:
- the decimal separator character
-
setDecimalSeparator
public void setDecimalSeparator(char decimalSeparator)
- Parameters:
decimalSeparator-
-
getGroupingSeparator
public char getGroupingSeparator()
- Returns:
- the grouping separator character
-
setGroupingSeparator
public void setGroupingSeparator(char groupingSeparator)
- Parameters:
groupingSeparator-
-
-