Content Engine Java API: SearchModifier

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.filenet.api.constants.SearchModifier

All Implemented Interfaces:

java.io.Serializable
```
public class SearchModifier
extends java.lang.Object
implements java.io.Serializable
```
Specifies search modifiers for Stored Search queries.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static SearchModifier`	`BOOST` Specifies that the relevance level of matching documents based on the terms found should be increased.
`static SearchModifier`	`FUZZY` Specifies that a fuzzy search algorithm will be enabled.
`static SearchModifier`	`PROXIMITY` Specifies searching for terms within a specific distance.

Method Summary

Methods
Modifier and Type	Method and Description
`static SearchModifier`	`getInstanceFromInt(int value)` Gets an instance of this class using its associated integer value (the `*_AS_INT` fields).
`int`	`getValue()` Returns an integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BOOST
```
public static final SearchModifier BOOST
```
    Specifies that the relevance level of matching documents based on the terms found should be increased.
  - PROXIMITY
```
public static final SearchModifier PROXIMITY
```
    Specifies searching for terms within a specific distance.
  - FUZZY
```
public static final SearchModifier FUZZY
```
    Specifies that a fuzzy search algorithm will be enabled.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns an integer value associated with a specific instance of this class.
    
    Returns:
    An integer representing a specific instance of this class.
  - getInstanceFromInt
```
public static SearchModifier getInstanceFromInt(int value)
```
    Gets an instance of this class using its associated integer value (the *_AS_INT fields).
    
    Parameters:
    value - An integer representing a particular static instance of this class.
    
    Returns:
    The referenced RefreshMode instance.
    
    Throws:
    
    EngineRuntimeException - Thrown when the value parameter is null or invalid.
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A String representing the instance.