com.unboundid.ldap.sdk.unboundidds.extensions

Enum MultiUpdateChangesApplied

java.lang.Object

java.lang.Enum<MultiUpdateChangesApplied>

com.unboundid.ldap.sdk.unboundidds.extensions.MultiUpdateChangesApplied

All Implemented Interfaces:

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

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

This enum defines the set of possible values for the element of a multi-update result which indicates whether any updates were applied to server data.

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.

See Also:

MultiUpdateExtendedResult

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Indicates that all of the changes contained in the multi-update request were applied to the server.
NONE Indicates that none of the changes contained in the multi-update request were applied to the server.
PARTIAL Indicates that one or more changes from the multi-update request were applied, but at least one failure was also encountered.

Method Summary

Modifier and Type	Method and Description
static MultiUpdateChangesApplied	forName(java.lang.String name) Retrieves the multi-update changes applied value with the specified name.
int	intValue() Retrieves the integer value associated with this changes applied value.
static MultiUpdateChangesApplied	valueOf(int intValue) Retrieves the multi-update changes applied value with the specified integer value.
static MultiUpdateChangesApplied	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MultiUpdateChangesApplied[]	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

NONE

public static final MultiUpdateChangesApplied NONE

Indicates that none of the changes contained in the multi-update request were applied to the server.

ALL

public static final MultiUpdateChangesApplied ALL

Indicates that all of the changes contained in the multi-update request were applied to the server.

PARTIAL

public static final MultiUpdateChangesApplied PARTIAL

Indicates that one or more changes from the multi-update request were applied, but at least one failure was also encountered.

Method Detail

values

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

Returns:

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

valueOf

public static MultiUpdateChangesApplied 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

intValue

public int intValue()

Retrieves the integer value associated with this changes applied value.

Returns:

The integer value associated with this changes applied value.

valueOf

@Nullable
public static MultiUpdateChangesApplied valueOf(int intValue)

Retrieves the multi-update changes applied value with the specified integer value.

Parameters:

intValue - The integer value for the changes applied value to retrieve.

Returns:

The multi-update changes applied value with the specified integer value, or null if there is no changes applied value with the specified integer value.

forName

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

Retrieves the multi-update changes applied value with the specified name.

Parameters:

name - The name of the multi-update changes applied value to retrieve. It must not be null.

Returns:

The requested multi-update changes applied value, or null if no such value is defined.