Package de.digitalcollections.model.list
Class ListRequest
- java.lang.Object
-
- de.digitalcollections.model.list.ListRequest
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
PageRequest
public class ListRequest extends Object implements Serializable
Container for querying a optionally filtered and sorted list:- filtering: container for filter criterias of result list
- sorting: container for sorting order of result list
- searchTerm: search term for simple query term to be searched for
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ListRequest()
ListRequest(Direction direction, String... properties)
Creates a newListRequest
with sorting parameters applied.ListRequest(Sorting sorting)
ListRequest(Sorting sorting, Filtering filtering, String searchTerm)
Creates a newListRequest
with sorting parameters applied.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListRequest
add(Filtering filtering)
Add all filter criteria of given filtering to existing filtering.ListRequest
add(Sorting sorting)
Add all sorting criteria of given sorting to existing sorting.boolean
equals(Object obj)
Filtering
getFiltering()
String
getSearchTerm()
Sorting
getSorting()
boolean
hasFiltering()
int
hashCode()
boolean
hasSorting()
protected void
init()
void
setFiltering(Filtering filtering)
void
setSearchTerm(String searchTerm)
void
setSorting(Sorting sorting)
String
toString()
-
-
-
Constructor Detail
-
ListRequest
public ListRequest()
-
ListRequest
public ListRequest(Direction direction, String... properties)
Creates a newListRequest
with sorting parameters applied.- Parameters:
direction
- the direction of theSorting
to be specified, can be null.properties
- the properties to sorting by, must not be null or empty.
-
ListRequest
public ListRequest(Sorting sorting)
-
ListRequest
public ListRequest(Sorting sorting, Filtering filtering, String searchTerm)
Creates a newListRequest
with sorting parameters applied.- Parameters:
sorting
- can be nullfiltering
- contains list of filter criteriassearchTerm
- search term for simple query term to be searched for
-
-
Method Detail
-
add
public ListRequest add(Filtering filtering)
Add all filter criteria of given filtering to existing filtering. Initialise if no existing filtering.- Parameters:
filtering
- new filtering criteria to add- Returns:
- the updated ListRequest instance
-
add
public ListRequest add(Sorting sorting)
Add all sorting criteria of given sorting to existing sorting. Initialise if no existing sorting.- Parameters:
sorting
- new sorting criteria to add- Returns:
- the updated ListRequest instance
-
getFiltering
public Filtering getFiltering()
- Returns:
- the filtering parameters
-
getSearchTerm
public String getSearchTerm()
- Returns:
- the search term to be searched for
-
getSorting
public Sorting getSorting()
- Returns:
- the sorting parameters
-
hasFiltering
public boolean hasFiltering()
- Returns:
- whether the request has defined any filtering.
-
hasSorting
public boolean hasSorting()
- Returns:
- whether the request has defined any sorting.
-
init
protected void init()
-
setFiltering
public void setFiltering(Filtering filtering)
- Parameters:
filtering
- the filtering criterias
-
setSearchTerm
public void setSearchTerm(String searchTerm)
-
setSorting
public void setSorting(Sorting sorting)
- Parameters:
sorting
- the sorting parameters
-
-