Content Engine Java API: SweepItemOutcome

java.lang.Object
- com.filenet.api.engine.SweepItemOutcome

All Implemented Interfaces:

java.io.Serializable
```
public class SweepItemOutcome
extends java.lang.Object
implements java.io.Serializable
```
The processing outcome of a SweepItem object by a SweepActionHandler implementation.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static SweepItemOutcome`	`FAILED` Specifies that the object failed during processing, the object is eligible for retry.
`static SweepItemOutcome`	`FAILED_NO_RETRY` Specifies that the object failed during processing, and that the object is not eligible for retry (fatal, non-recoverable error was detected).
`static SweepItemOutcome`	`IGNORED` Specifies that the object was ignored by the SweepActionHandler, the handler may have filtered the object out, or may have failed before processing the object.
`static SweepItemOutcome`	`PROCESSED` Specifies that the object was successfully processed by the SweepActionHandler.

Method Summary

Methods
Modifier and Type	Method and Description
`static SweepItemOutcome`	`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
  - IGNORED
```
public static final SweepItemOutcome IGNORED
```
    Specifies that the object was ignored by the SweepActionHandler, the handler may have filtered the object out, or may have failed before processing the object.
  - PROCESSED
```
public static final SweepItemOutcome PROCESSED
```
    Specifies that the object was successfully processed by the SweepActionHandler.
  - FAILED
```
public static final SweepItemOutcome FAILED
```
    Specifies that the object failed during processing, the object is eligible for retry.
  - FAILED_NO_RETRY
```
public static final SweepItemOutcome FAILED_NO_RETRY
```
    Specifies that the object failed during processing, and that the object is not eligible for retry (fatal, non-recoverable error was detected).
- 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 SweepItemOutcome 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 SweepItemOutcome 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.

Methods inherited from class java.lang.Object

IGNORED

PROCESSED

FAILED

FAILED_NO_RETRY

getValue

getInstanceFromInt

toString