FacetParameterContext (Hibernate Search 5 Migration Helper - Engine 6.0.0.CR2 API)

All Superinterfaces:

FacetTermination

All Known Subinterfaces:

DiscreteFacetContext, FacetRangeAboveContext<T>, FacetRangeBelowContinuationContext<T>, FacetRangeEndContext<T>
```
@Deprecated
public interface FacetParameterContext
extends FacetTermination
```
Deprecated.
See the deprecation note on FacetContext.

Author:

Hardy Ferentschik

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`FacetParameterContext`	`includeZeroCounts(boolean zeroCounts)`	Deprecated.
`FacetParameterContext`	`maxFacetCount(int maxFacetCount)`	Deprecated. Limits the maximum numbers of facets to the specified number.
`FacetParameterContext`	`orderedBy(FacetSortOrder sort)`	Deprecated.

Methods inherited from interface org.hibernate.search.query.dsl.FacetTermination
createFacetingRequest

- Method Detail
  - orderedBy
```
FacetParameterContext orderedBy(FacetSortOrder sort)
```
    Deprecated.
    
    Parameters:
    
    sort - the sort order for the returned facets.
    
    Returns:
    
    a FacetParameterContext to continue building the facet request
  - includeZeroCounts
```
FacetParameterContext includeZeroCounts(boolean zeroCounts)
```
    Deprecated.
    
    Parameters:
    
    zeroCounts - Determines whether values with zero counts are included into the facet result
    
    Returns:
    
    a FacetParameterContext to continue building the facet request
  - maxFacetCount
```
FacetParameterContext maxFacetCount(int maxFacetCount)
```
    Deprecated.
    
    Limits the maximum numbers of facets to the specified number.
    
    Parameters:
    
    maxFacetCount - the maximum number of facets to include in the response. A negative value means that all facets will be included
    
    Returns:
    
    a FacetParameterContext to continue building the facet request