net.sf.mmm.util.search.api

Interface SearchCriteria

All Superinterfaces:

Entity, Serializable, TransferObject

All Known Implementing Classes:

AbstractSearchCriteria

public interface SearchCriteria
extends TransferObject

This is the interface for a transfer-object with the criteria for a search query. Such object specifies the criteria selecting which hits will match when performing a search.
NOTE:
This interface only holds generic settings for the query such as getHitOffset(), getMaximumHitCount(), and getSearchTimeout(). For your individual search, you can extend AbstractSearchCriteria to create a java bean with all the fields for your search. For searches in a database using JPA there is additional support provided by mmm-persistence.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchResult

Method Summary

Modifier and Type	Method and Description
int	getHitOffset() This method gets the offset for the first hit.
Integer	getMaximumHitCount() This method gets the maximum number of hits that will be received as result for this query.
Long	getSearchTimeout() This method gets the maximum delay in milliseconds the search may last until it is canceled.
boolean	isReadOnly() This method determines if the search should be performed in read-only mode.

Method Detail

getMaximumHitCount

Integer getMaximumHitCount()

This method gets the maximum number of hits that will be received as result for this query.
Note:
This feature is the same as Query.setMaxResults(int) in JPA.

Returns:

the maximum hit-count or null for NO limit.

getHitOffset

int getHitOffset()

This method gets the offset for the first hit. This is 0 by default. By providing a multiple of getMaximumHitCount() you can simply implement paging.
Note:
This feature is the same as Query.setFirstResult(int) in JPA.

Returns:

the offset of the first hit.

getSearchTimeout

Long 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.

isReadOnly

boolean isReadOnly()

This method determines if the search should be performed in read-only mode. In such case the result hits can NOT be modified or their changes will NOT be persisted. If a search-engine does not support this feature (e.g. for full-text search this makes no sense), it will be ignored.

Returns:

true if read-only, false otherwise (default).

Since:

3.1.0