Boost (Enterprise Search Java Client 0.0.4 API)

All Known Implementing Classes:

DateValueBoost, FunctionalBoost, GeolocationProximityBoost, NumberProximityBoost, NumericValueBoost, RecencyBoost, TextValueBoost
```
public interface Boost
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Boost.BoostType

static class Boost.Function

static class Boost.Operation

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`BigDecimal`	`getFactor()`	Alter the impact of a boost on the score of a document.
`String`	`getName()`
`Boost.BoostType`	`getType()`	Type of boost
`Boost`	`setFactor(BigDecimal factor)`	Alter the impact of a boost on the score of a document.
`Boost`	`setName(String name)`

- Method Detail
  - getName
```
String getName()
```
  - setName
```
Boost setName(String name)
```
  - getType
```
Boost.BoostType getType()
```
    Type of boost
    
    Returns:
    
    The boost type
  - getFactor
```
BigDecimal getFactor()
```
    Alter the impact of a boost on the score of a document. Must be between 0 and 10. Defaults to 1.0. A negative factor or fractional factor will not deboost a result. The factor parameter multiplies the value of the boost but does not significantly affect the decay function scale.
    
    Returns:
    
    The factor
  - setFactor
```
Boost setFactor(BigDecimal factor)
```
    Alter the impact of a boost on the score of a document. Must be between 0 and 10. Defaults to 1.0. A negative factor or fractional factor will not deboost a result. The factor parameter multiplies the value of the boost but does not significantly affect the decay function scale.
    
    Parameters:
    
    factor - A value between (inclusive) 0.0 and 10.0
    
    Returns:
    
    The boost