Content Engine Java API: RequiredState

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

All Implemented Interfaces:

java.io.Serializable
```
public class RequiredState
extends java.lang.Object
implements java.io.Serializable
```
Specifies the possible required states for Stored Search queries.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static RequiredState`	`NONE` Specifies no required state.
`static RequiredState`	`PROHIBITED` Specifies that a term is prohibited in a Stored Search query.
`static RequiredState`	`REQUIRED` Specifies that a term is required in a Stored Search query.

Method Summary

Methods
Modifier and Type	Method and Description
`static RequiredState`	`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
  - NONE
```
public static final RequiredState NONE
```
    Specifies no required state.
  - PROHIBITED
```
public static final RequiredState PROHIBITED
```
    Specifies that a term is prohibited in a Stored Search query. Text containing the term will not be returned by the query.
  - REQUIRED
```
public static final RequiredState REQUIRED
```
    Specifies that a term is required in a Stored Search query. Only text containing the term will be returned by the query.
- 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 RequiredState 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.