com.endeca.cas.extension
Enum AcquisitionEndState

java.lang.Object
  java.lang.Enum<AcquisitionEndState>
      com.endeca.cas.extension.AcquisitionEndState

All Implemented Interfaces:

Serializable, Comparable<AcquisitionEndState>

public enum AcquisitionEndState
extends Enum<AcquisitionEndState>

Indicates the state of the acquisition process when it ended.

See Also:

PipelineComponentRuntime

Enum Constant Summary

FAILURE
Indicates the acquisition has failed.

FULL_ACQUISITION_RECOVERY_REQUIRED
Indicates the acquisition has failed in a way that requires a full acquisition the next time the acquistion runs.

SUCCESS
Indicates the acquisition has completed successfully.

Method Summary

static AcquisitionEndState	valueOf(String name) Returns the enum constant of this type with the specified name.
static AcquisitionEndState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final AcquisitionEndState SUCCESS

Indicates the acquisition has completed successfully.

FAILURE

public static final AcquisitionEndState FAILURE

Indicates the acquisition has failed.

FULL_ACQUISITION_RECOVERY_REQUIRED

public static final AcquisitionEndState FULL_ACQUISITION_RECOVERY_REQUIRED

Indicates the acquisition has failed in a way that requires a full acquisition the next time the acquistion runs. For example, this can happen if an IncrementalDataSourceRuntime cannot rollback any state changes after an incremental acquisition.

Method Detail

values

public static AcquisitionEndState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AcquisitionEndState c : AcquisitionEndState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AcquisitionEndState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null