Package net.sourceforge.jbizmo.commons.search.dto

Class SearchInput

java.lang.Object

net.sourceforge.jbizmo.commons.search.dto.SearchInput

All Implemented Interfaces:

Serializable

public class SearchInput
extends Object
implements Serializable

Data transfer object for generic search operations via integration services (e.g. REST or SOAP)

Copyright 2016 (C) by Martin Ganserer

Version:

1.0.0

Author:

Martin Ganserer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SearchInput()	Constructor

Method Summary

Modifier and Type	Method	Description
void	addSearchField(String name, FilterOperatorEnum operator)	Add a search field
void	addSearchField(String name, FilterOperatorEnum operator, String filterCriteria)	Add a search field
void	addSearchField(String name, FilterOperatorEnum operator, String filterCriteria, SortDirectionEnum sortOrder)	Add a search field
String	getDateFormat()
String	getDateTimeFormat()
char	getDecimalSeparator()
char	getGroupingSeparator()
int	getMaxResult()
String	getNumberFormat()
List<SearchInputField>	getSearchFields()
int	getStartIndex()
boolean	isCaseSensitive()
boolean	isExactFilterMatch()
void	setCaseSensitive(boolean caseSensitive)
void	setDateFormat(String dateFormat)
void	setDateTimeFormat(String dateTimeFormat)
void	setDecimalSeparator(char decimalSeparator)
void	setExactFilterMatch(boolean exactFilterMatch)
void	setGroupingSeparator(char groupingSeparator)
void	setMaxResult(int maxResult)
void	setNumberFormat(String numberFormat)
void	setSearchFields(List<SearchInputField> searchFields)
void	setStartIndex(int startIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchInput

public SearchInput()

Constructor

Method Detail

addSearchField

public void addSearchField(String name,
                           FilterOperatorEnum operator)

Add a search field

Parameters:

name -

operator -

addSearchField

public void addSearchField(String name,
                           FilterOperatorEnum operator,
                           String filterCriteria)

Add a search field

Parameters:

name -

operator -

filterCriteria -

addSearchField

public void addSearchField(String name,
                           FilterOperatorEnum operator,
                           String filterCriteria,
                           SortDirectionEnum sortOrder)

Add a search field

Parameters:

name -

operator -

filterCriteria -

sortOrder -

getDateTimeFormat

public String getDateTimeFormat()

Returns:

the date time format

setDateTimeFormat

public void setDateTimeFormat(String dateTimeFormat)

Parameters:

dateTimeFormat -

isCaseSensitive

public boolean isCaseSensitive()

Returns:

true if the search should be case sensitive

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Parameters:

caseSensitive -

getDateFormat

public String getDateFormat()

Returns:

the date format that is used

setDateFormat

public void setDateFormat(String dateFormat)

Parameters:

dateFormat -

getMaxResult

public int getMaxResult()

Returns:

the max. number of objects that should be returned

setMaxResult

public void setMaxResult(int maxResult)

Parameters:

maxResult -

getNumberFormat

public String getNumberFormat()

Returns:

the number format

setNumberFormat

public void setNumberFormat(String numberFormat)

Parameters:

numberFormat -

getSearchFields

public List<SearchInputField> getSearchFields()

Returns:

the search fields

setSearchFields

public void setSearchFields(List<SearchInputField> searchFields)

Parameters:

searchFields -

getStartIndex

public int getStartIndex()

Returns:

the start index

setStartIndex

public void setStartIndex(int startIndex)

Parameters:

startIndex -

isExactFilterMatch

public boolean isExactFilterMatch()

Returns:

true if an exact filter match is expected

setExactFilterMatch

public void setExactFilterMatch(boolean exactFilterMatch)

Parameters:

exactFilterMatch -

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 -