Content Engine Java API: TextSearchServerMode

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

All Implemented Interfaces:

java.io.Serializable
```
public final class TextSearchServerMode
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that identify the usage mode of the IBM® Content Search Services server. The usage mode specifies which tasks can be performed by an IBM Content Search Services server so that the work load can be balanced across multiple, task-dedicated servers.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TextSearchServerMode`	`INDEX` The server performs only indexing tasks.
`static TextSearchServerMode`	`INDEX_AND_SEARCH` The server performs both indexing and search tasks.
`static int`	`INDEX_AND_SEARCH_AS_INT` An `int` value associated with the INDEX_AND_SEARCH instance of this class.
`static int`	`INDEX_AS_INT` An `int` value associated with the INDEX instance of this class.
`static TextSearchServerMode`	`SEARCH` The server performs only search tasks.
`static int`	`SEARCH_AS_INT` An `int` value associated with the SEARCH instance of this class.

Method Summary

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

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

- Field Detail
  - INDEX_AS_INT
```
public static final int INDEX_AS_INT
```
    An int value associated with the INDEX instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - INDEX
```
public static final TextSearchServerMode INDEX
```
    The server performs only indexing tasks.
  - INDEX_AND_SEARCH_AS_INT
```
public static final int INDEX_AND_SEARCH_AS_INT
```
    An int value associated with the INDEX_AND_SEARCH instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - INDEX_AND_SEARCH
```
public static final TextSearchServerMode INDEX_AND_SEARCH
```
    The server performs both indexing and search tasks. IBM does not recommend this usage mode for a general production system.
  - SEARCH_AS_INT
```
public static final int SEARCH_AS_INT
```
    An int value associated with the SEARCH instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SEARCH
```
public static final TextSearchServerMode SEARCH
```
    The server performs only search tasks.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static TextSearchServerMode getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    See Also:
    getValue()

Methods inherited from class java.lang.Object

INDEX_AS_INT

INDEX

INDEX_AND_SEARCH_AS_INT

INDEX_AND_SEARCH

SEARCH_AS_INT

SEARCH

getValue

toString

getInstanceFromInt