de.whitefrog.frogr.model

Class SearchParameter

java.lang.Object

de.whitefrog.frogr.model.SearchParameter

All Implemented Interfaces:

Serializable

public class SearchParameter
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchParameter.OrderBy
static class	SearchParameter.SortOrder

Field Summary

Fields

Modifier and Type	Field and Description
static int	DefaultLimit
static Locale	DefaultLocale

Constructor Summary

Constructors

Constructor and Description
SearchParameter()
SearchParameter(int limit)
SearchParameter(int page, int limit)

Method Summary

Modifier and Type	Method and Description
SearchParameter	clone()
boolean	containsFilter(String property)
boolean	count()
SearchParameter	count(boolean count)
boolean	fetch()
de.whitefrog.frogr.model.FieldList	fieldList()
List<String>	fields()
SearchParameter	fields(de.whitefrog.frogr.model.FieldList fields)
SearchParameter	fields(de.whitefrog.frogr.model.QueryField... fields)
SearchParameter	fields(String... fields)
SearchParameter	filter(Filter filter)
SearchParameter	filter(String property, String value)
Collection<Filter>	filters()
List<Filter>	getFilter(String property)
List<Long>	ids()
SearchParameter	ids(Collection<Long> ids)
SearchParameter	ids(Long... ids)
SearchParameter	incrementPage()
boolean	isFiltered()
boolean	isOrdered()
int	limit()
SearchParameter	limit(int limit)
Locale	locale()
SearchParameter	locale(Locale locale)
List<SearchParameter.OrderBy>	orderBy()
SearchParameter	orderBy(String field)
SearchParameter	orderBy(String field, SearchParameter.SortOrder dir)
int	page()
SearchParameter	page(int page)
String	query()
SearchParameter	query(String query)
SearchParameter	removeFilter(String property)
List<String>	returns()
SearchParameter	returns(String... fields)
int	start()
SearchParameter	start(int start)
String	toString()
List<String>	uuids()
SearchParameter	uuids(Collection<String> uuids)
SearchParameter	uuids(String... uuids)

Methods inherited from class java.lang.Object

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

Field Detail

DefaultLimit

public static final int DefaultLimit

See Also:

Constant Field Values

DefaultLocale

public static final Locale DefaultLocale

Constructor Detail

SearchParameter

public SearchParameter()

SearchParameter

public SearchParameter(int limit)

SearchParameter

public SearchParameter(int page,
                       int limit)

Method Detail

clone

public SearchParameter clone()

Overrides:

clone in class Object

count

public boolean count()

count

public SearchParameter count(boolean count)

containsFilter

public boolean containsFilter(String property)

fields

public SearchParameter fields(String... fields)

fields

public SearchParameter fields(de.whitefrog.frogr.model.QueryField... fields)

fields

public SearchParameter fields(de.whitefrog.frogr.model.FieldList fields)

fields

public List<String> fields()

fieldList

public de.whitefrog.frogr.model.FieldList fieldList()

locale

public SearchParameter locale(Locale locale)

locale

public Locale locale()

query

public String query()

query

public SearchParameter query(String query)

fetch

public boolean fetch()

filters

public Collection<Filter> filters()

getFilter

public List<Filter> getFilter(String property)

filter

public SearchParameter filter(String property,
                              String value)

filter

public SearchParameter filter(Filter filter)

removeFilter

public SearchParameter removeFilter(String property)

start

public SearchParameter start(int start)

start

public int start()

isFiltered

public boolean isFiltered()

ids

public List<Long> ids()

ids

public SearchParameter ids(Long... ids)

ids

public SearchParameter ids(Collection<Long> ids)

uuids

public List<String> uuids()

uuids

public SearchParameter uuids(String... uuids)

uuids

public SearchParameter uuids(Collection<String> uuids)

limit

public int limit()

limit

public SearchParameter limit(int limit)

page

public int page()

page

public SearchParameter page(int page)

incrementPage

public SearchParameter incrementPage()

orderBy

public List<SearchParameter.OrderBy> orderBy()

orderBy

public SearchParameter orderBy(String field)

orderBy

public SearchParameter orderBy(String field,
                               SearchParameter.SortOrder dir)

isOrdered

public boolean isOrdered()

returns

public SearchParameter returns(String... fields)

returns

public List<String> returns()

toString

public String toString()

Overrides:

toString in class Object