com.sdl.delivery.iq.query.api

Interface QueryFilter

All Known Subinterfaces:

ResultFilter

All Known Implementing Classes:

SearchResultFilter

public interface QueryFilter

Contains several filters for query result manipulation.

Method Summary

Modifier and Type	Method and Description
OptionalInt	getEndOfRange() Returns the preset result set end.
Optional<Set<String>>	getExcludeFields() Returns the preset exclude filters.
String	getIndex() Returns the index.
OptionalInt	getMaxResults() Returns the preset max results.
OptionalInt	getStartOfRange() Returns the preset result set start.
boolean	highLightInAllIsEnabled() Use to highlight in all fields.
boolean	highLightingIsEnabled() Checks whether highlighting in results is enabled.

Method Detail

getMaxResults

OptionalInt getMaxResults()

Returns the preset max results.

Returns:

The mex results.

getStartOfRange

OptionalInt getStartOfRange()

Returns the preset result set start.

Returns:

The result set start.

getEndOfRange

OptionalInt getEndOfRange()

Returns the preset result set end.

Returns:

The result set end.

getExcludeFields

Optional<Set<String>> getExcludeFields()

Returns the preset exclude filters.

Returns:

The exclude filters.

highLightingIsEnabled

boolean highLightingIsEnabled()

Checks whether highlighting in results is enabled.

Returns:

a boolean.

highLightInAllIsEnabled

boolean highLightInAllIsEnabled()

Use to highlight in all fields.

Returns:

a boolean.

getIndex

String getIndex()

Returns the index.

Returns:

the index name