com.unboundid.ldap.sdk.unboundidds.controls

Enum UniquenessValidationResult

java.lang.Object

java.lang.Enum<UniquenessValidationResult>

com.unboundid.ldap.sdk.unboundidds.controls.UniquenessValidationResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UniquenessValidationResult>

public enum UniquenessValidationResult
extends java.lang.Enum<UniquenessValidationResult>

This enum defines a set of values that provide information about the result of validation processing that the server performed in response to a UniquenessRequestControl.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
VALIDATION_FAILED Indicates that the server found at least one other entry in the server that conflicted with the attempted write operation.
VALIDATION_NOT_ATTEMPTED Indicates that the server did not attempt any uniqueness validation processing at the associated point in operation processing.
VALIDATION_PASSED Indicates that the server verified that the requested update did not conflict with any existing entries at the time the validation processing was performed.

Method Summary

Modifier and Type	Method and Description
static UniquenessValidationResult	forName(java.lang.String name) Retrieves the uniqueness validation result with the given name.
java.lang.String	getName() Retrieves the name for this uniqueness validation result.
java.lang.String	toString() Retrieves a string representation for this uniqueness validation result.
static UniquenessValidationResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UniquenessValidationResult[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VALIDATION_PASSED

public static final UniquenessValidationResult VALIDATION_PASSED

Indicates that the server verified that the requested update did not conflict with any existing entries at the time the validation processing was performed.

VALIDATION_FAILED

public static final UniquenessValidationResult VALIDATION_FAILED

Indicates that the server found at least one other entry in the server that conflicted with the attempted write operation.

VALIDATION_NOT_ATTEMPTED

public static final UniquenessValidationResult VALIDATION_NOT_ATTEMPTED

Indicates that the server did not attempt any uniqueness validation processing at the associated point in operation processing. Potential reasons that no validation may have been attempted include that the UniquenessRequestControl indicated that no validation was required at that point in the processing, because the uniqueness constraint did not apply to the associated operation (for example, the control indicated that uniqueness should be maintained for an attribute that was not included in the update), or that the operation failed for some reason that was not related to uniqueness processing.

Method Detail

values

public static UniquenessValidationResult[] 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 (UniquenessValidationResult c : UniquenessValidationResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static UniquenessValidationResult valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this uniqueness validation result.

Returns:

The name for this uniqueness validation result.

forName

@Nullable
public static UniquenessValidationResult forName(@NotNull
                                                           java.lang.String name)

Retrieves the uniqueness validation result with the given name.

Parameters:

name - The name for the uniqueness validation result to retrieve. It must not be null.

Returns:

The uniqueness validation result with the given name, or null if there is no result with the given name.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation for this uniqueness validation result.

Overrides:

toString in class java.lang.Enum<UniquenessValidationResult>

Returns:

A string representation for this uniqueness validation result.