Content Engine Java API: IndexingOperation

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

All Implemented Interfaces:

java.io.Serializable
```
public final class IndexingOperation
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that are used by the IndexingOperation property of a CmIndexRequest object to identify the type of index request operation.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static IndexingOperation`	`CREATE` Indicates that an index entry is to be created.
`static int`	`CREATE_AS_INT` An `int` value associated with the CREATE instance of this class.
`static IndexingOperation`	`DELETE` Indicates that an index entry is to be deleted.
`static int`	`DELETE_AS_INT` An `int` value associated with the DELETE instance of this class.
`static IndexingOperation`	`NO_OP` For internal use only.
`static int`	`NO_OP_AS_INT` An `int` value associated with the NO_OP instance of this class.
`static IndexingOperation`	`SKIP` Indicates that an index request is to be skipped.
`static int`	`SKIP_AS_INT` An `int` value associated with the SKIP instance of this class.
`static IndexingOperation`	`UPDATE` Indicates that an existing index entry is to be replaced with an updated entry.
`static int`	`UPDATE_AS_INT` An `int` value associated with the UPDATE instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static IndexingOperation`	`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
  - UPDATE_AS_INT
```
public static final int UPDATE_AS_INT
```
    An int value associated with the UPDATE 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
  - UPDATE
```
public static final IndexingOperation UPDATE
```
    Indicates that an existing index entry is to be replaced with an updated entry. An update index request is generated if the CBR-enabled object is modified and has a non-null IndexationId property value.
  - CREATE_AS_INT
```
public static final int CREATE_AS_INT
```
    An int value associated with the CREATE 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
  - CREATE
```
public static final IndexingOperation CREATE
```
    Indicates that an index entry is to be created.
  - DELETE_AS_INT
```
public static final int DELETE_AS_INT
```
    An int value associated with the DELETE 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
  - DELETE
```
public static final IndexingOperation DELETE
```
    Indicates that an index entry is to be deleted.
  - NO_OP_AS_INT
```
public static final int NO_OP_AS_INT
```
    An int value associated with the NO_OP 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
  - NO_OP
```
public static final IndexingOperation NO_OP
```
    For internal use only.
  - SKIP_AS_INT
```
public static final int SKIP_AS_INT
```
    An int value associated with the SKIP 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
  - SKIP
```
public static final IndexingOperation SKIP
```
    Indicates that an index request is to be skipped. For this operation, the Content Engine server will not index the CBR-enabled object that is the subject of an index request. The Content Engine server sets the CmIndexingFailureCode property of the index request to MARKED_AS_SKIPPED and sets the IndexationId property of the CBR-enabled object to null. This value is the only user-settable value.
- 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 IndexingOperation 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

UPDATE_AS_INT

UPDATE

CREATE_AS_INT

CREATE

DELETE_AS_INT

DELETE

NO_OP_AS_INT

NO_OP

SKIP_AS_INT

SKIP

getValue

toString

getInstanceFromInt