Content Engine Java API: SweepResultType

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

All Implemented Interfaces:

java.io.Serializable
```
public final class SweepResultType
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that identify the the type of sweep result record.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static SweepResultType`	`FAILURE` The failure record is of type failure.
`static int`	`FAILURE_AS_INT` An `int` value associated with the FAILURE instance of this class.
`static SweepResultType`	`PREVIEW` The result record is of type preview.
`static int`	`PREVIEW_AS_INT` An `int` value associated with the PREVIEW instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static SweepResultType`	`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
  - PREVIEW_AS_INT
```
public static final int PREVIEW_AS_INT
```
    An int value associated with the PREVIEW 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
  - PREVIEW
```
public static final SweepResultType PREVIEW
```
    The result record is of type preview. This indicates that the sweep executed in preview mode, and the sweep would attempt to process the source object if the sweep were operating in normal execution mode. (No processing occurs in preview mode.)
  - FAILURE_AS_INT
```
public static final int FAILURE_AS_INT
```
    An int value associated with the FAILURE 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
  - FAILURE
```
public static final SweepResultType FAILURE
```
    The failure record is of type failure. This indicates that the sweep executed in normal mode and failed to process the swept object.
- 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 SweepResultType 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

PREVIEW_AS_INT

PREVIEW

FAILURE_AS_INT

FAILURE

getValue

toString

getInstanceFromInt