Package com.polarion.platform.persistence

Interface IIndexSearch

public interface IIndexSearch

Builder interface providing the methods to configure and execute index searches.

Since:

3.23.4

Method Summary

Modifier and Type	Method	Description
IIndexSearch	baseline(String revision)	Revision of the baseline that the search should be executed for.
IIndexSearch	indexName(String indexName)	The index name.
IIndexSearch	limit(int limit)	The maximum number of items to be returned, -1 for unlimited.
IIndexSearch	offset(int offset)	The number of first items to exclude from the result list.
IIndexSearch	query(String query)	Lucene query.
IIndexSearchResult	result()
IIndexSearch	sort(String sort)	Lucene sort string, null sorts by relevance.

Method Details

indexName

@NotNull
IIndexSearch indexName(@NotNull
 String indexName)

The index name. This is a mandatory property. Only the last value is used when the method is called more than once.

query

@NotNull
IIndexSearch query(@Nullable
 String query)

Lucene query. Only the last value is used when the method is called more than once.

sort

@NotNull
IIndexSearch sort(@Nullable
 String sort)

Lucene sort string, null sorts by relevance. Only the last value is used when the method is called more than once.

baseline

@NotNull
IIndexSearch baseline(@Nullable
 String revision)

Revision of the baseline that the search should be executed for. Only the last value is used when the method is called more than once.

limit

@NotNull
IIndexSearch limit(int limit)

The maximum number of items to be returned, -1 for unlimited. Only the last value is used when the method is called more than once.

offset

@NotNull
IIndexSearch offset(int offset)

The number of first items to exclude from the result list. If the offset exceeds the total number of objects, an empty list is returned. Only the last value is used when the method is called more than once.

result

@NotNull
IIndexSearchResult result()