Boost (Enterprise Search Java Client 0.5.5 API)

All Known Implementing Classes:

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

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`Boost.BoostType`	The boosting types that are available
`static class`	`Boost.Function`	Decay functions score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin See Supported Decay Functions
`static class`	`Boost.Operation`	The boosting operations that are available

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()`	The name of the boost
`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)`	Set the name of the boost

- Method Detail
  - getName
```
String getName()
```
    The name of the boost
    
    Returns:
    
    the name
  - setName
```
Boost setName(String name)
```
    Set the name of the boost
    
    Parameters:
    
    name - The boost name
    
    Returns:
    
    The Boost object
  - 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