Content Engine Java API: TextSearchServerStatus

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

All Implemented Interfaces:

java.io.Serializable
```
public final class TextSearchServerStatus
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that identify the status of the IBM® Content Search Services server.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TextSearchServerStatus`	`DISABLED` The IBM® Content Search Services server is disabled for maintenance purposes.
`static int`	`DISABLED_AS_INT` An `int` value associated with the DISABLED instance of this class.
`static TextSearchServerStatus`	`ENABLED` The IBM® Content Search Services server is enabled and can be specified by its usage mode (TextSearchServerMode property).
`static int`	`ENABLED_AS_INT` An `int` value associated with the ENABLED instance of this class.
`static TextSearchServerStatus`	`UNAVAILABLE` The Content Engine server cannot communicate with the IBM® Content Search Services server.
`static int`	`UNAVAILABLE_AS_INT` An `int` value associated with the UNAVAILABLE instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static TextSearchServerStatus`	`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
  - UNAVAILABLE_AS_INT
```
public static final int UNAVAILABLE_AS_INT
```
    An int value associated with the UNAVAILABLE 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
  - UNAVAILABLE
```
public static final TextSearchServerStatus UNAVAILABLE
```
    The Content Engine server cannot communicate with the IBM® Content Search Services server.
  - DISABLED_AS_INT
```
public static final int DISABLED_AS_INT
```
    An int value associated with the DISABLED 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
  - DISABLED
```
public static final TextSearchServerStatus DISABLED
```
    The IBM® Content Search Services server is disabled for maintenance purposes.
  - ENABLED_AS_INT
```
public static final int ENABLED_AS_INT
```
    An int value associated with the ENABLED 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
  - ENABLED
```
public static final TextSearchServerStatus ENABLED
```
    The IBM® Content Search Services server is enabled and can be specified by its usage mode (TextSearchServerMode property). The Content Engine server verifies that there is a connection to the IBM Content Search Services server.
- 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 TextSearchServerStatus 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

UNAVAILABLE_AS_INT

UNAVAILABLE

DISABLED_AS_INT

DISABLED

ENABLED_AS_INT

ENABLED

getValue

toString

getInstanceFromInt