com.unboundid.directory.sdk.ds.types
Class SubordinateModifyDNPluginResult

java.lang.Object
  com.unboundid.directory.sdk.ds.types.SubordinateModifyDNPluginResult

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SubordinateModifyDNPluginResult
extends java.lang.Object
implements java.io.Serializable

This class defines a structure which may be used to provide information about the result of the processing performed by a subordinate modify DN plugin.

See Also:

Serialized Form

Field Summary

static SubordinateModifyDNPluginResult

SUCCESS A predefined result instance that indicates all processing completed successfully.

Constructor Summary

SubordinateModifyDNPluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean abortModifyDNOperation)
Creates a new subordinate modify DN plugin result with the provided information.

Method Summary

boolean	abortModifyDNOperation() Indicates whether to abort the modify DN operation and revert any changes that may have already been applied for it.
boolean	connectionTerminated() Indicates whether the client connection was terminated by the plugin.
boolean	continuePluginProcessing() Indicates whether to continue processing other subordinate modify DN plugins for the associated entry.
java.lang.String	toString() Retrieves a string representation of this search entry plugin result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SUCCESS

public static final SubordinateModifyDNPluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

SubordinateModifyDNPluginResult

public SubordinateModifyDNPluginResult(boolean connectionTerminated,
                                       boolean continuePluginProcessing,
                                       boolean abortModifyDNOperation)

Creates a new subordinate modify DN plugin result with the provided information.

Parameters:

connectionTerminated - Indicates whether the client connection was terminated by the plugin.

continuePluginProcessing - Indicates whether to continue processing other subordinate modify DN plugins for the associated entry.

abortModifyDNOperation - Indicates whether to abort all processing for the modify DN operation and revert any changes that may have already been applied for it.

Method Detail

connectionTerminated

public boolean connectionTerminated()

Indicates whether the client connection was terminated by the plugin.

Returns:

true if the client connection was terminated by the plugin, or false if not.

continuePluginProcessing

public boolean continuePluginProcessing()

Indicates whether to continue processing other subordinate modify DN plugins for the associated entry.

Returns:

true if the server should continue processing other subordinate modify DN plugins for the associated entry, or false if not.

abortModifyDNOperation

public boolean abortModifyDNOperation()

Indicates whether to abort the modify DN operation and revert any changes that may have already been applied for it.

Returns:

true if the server should abort the modify DN operation, or false if not.

toString

public java.lang.String toString()

Retrieves a string representation of this search entry plugin result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this search entry plugin result.