io.oasp.module.jpa.common.api.to

Class SearchCriteriaTo

java.lang.Object

io.oasp.module.basic.common.api.to.AbstractTo

io.oasp.module.jpa.common.api.to.SearchCriteriaTo

All Implemented Interfaces:

Serializable, net.sf.mmm.util.entity.api.Entity, net.sf.mmm.util.transferobject.api.TransferObject

public class SearchCriteriaTo
extends AbstractTo

This is the interface for a transfer-object with the criteria for a search and pagination query. Such object specifies the criteria selecting which hits will match when performing a search.
NOTE:
This interface only holds the necessary settings for the pagination part of a query. For your individual search, you extend SearchCriteriaTo to create a java bean with all the fields for your search.

Author:

hohwille

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private PaginationTo	pagination
private Integer	searchTimeout
private static long	serialVersionUID UID for serialization.
private List<OrderByTo>	sort

Constructor Summary

Constructors

Constructor and Description
SearchCriteriaTo() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PaginationTo	getPagination() The currently active pagination.
Integer	getSearchTimeout() This method gets the maximum delay in milliseconds the search may last until it is canceled.
List<OrderByTo>	getSort()
void	limitMaximumPageSize(int limit) Limits the page size by the given limit.
void	setPagination(PaginationTo pagination)
void	setSearchTimeout(int searchTimeout)
void	setSort(List<OrderByTo> sort)

Methods inherited from class io.oasp.module.basic.common.api.to.AbstractTo

toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

pagination

private PaginationTo pagination

See Also:

getPagination()

searchTimeout

private Integer searchTimeout

See Also:

getSearchTimeout

sort

private List<OrderByTo> sort

See Also:

getSort()

Constructor Detail

SearchCriteriaTo

public SearchCriteriaTo()

The constructor.

Method Detail

getPagination

public PaginationTo getPagination()

The currently active pagination.

Returns:

pagination the currently active pagination or PaginationTo.NO_PAGINATION if no specific pagination has been set. Will never return null.

setPagination

public void setPagination(PaginationTo pagination)

Parameters:

pagination - the pagination to set

limitMaximumPageSize

public void limitMaximumPageSize(int limit)

Limits the page size by the given limit.

If currently no pagination is active, or the current page size is null or greater than the given limit, the value is replaced by limit

Parameters:

limit - is the maximum allowed value for the page size.

getSearchTimeout

public Integer getSearchTimeout()

This method gets the maximum delay in milliseconds the search may last until it is canceled.
Note:
This feature is the same as the query hint "javax.persistence.query.timeout" in JPA.

Returns:

the search timeout in milliseconds or null for NO timeout.

setSearchTimeout

public void setSearchTimeout(int searchTimeout)

Parameters:

searchTimeout - is the new value of getSearchTimeout().

getSort

public List<OrderByTo> getSort()

Returns:

sort Sort criterias list

setSort

public void setSort(List<OrderByTo> sort)

Parameters:

sort - Set the sort criterias list