com.unboundid.directory.sdk.common.operation.ModifyDNResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of server-sdk Show documentation

The UnboundID Server SDK is a library that may be used to develop various types of extensions to Ping Identity server products, including the PingDirectory Server, PingDirectoryProxy Server, PingDataSync Server, PingDataMetrics Server, and PingAuthorize Server.

The newest version!

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * docs/licenses/cddl.txt
 * or http://www.opensource.org/licenses/cddl1.php.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * docs/licenses/cddl.txt.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Portions Copyright 2010-2024 Ping Identity Corporation
 */
package com.unboundid.directory.sdk.common.operation;



import com.unboundid.directory.sdk.common.types.AssuredReplicationRequirements;
import com.unboundid.directory.sdk.common.types.Entry;
import com.unboundid.util.NotExtensible;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;



/**
 * This interface defines a set of methods which may be used to interact with
 * modify DN results.
 */
@NotExtensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
public interface ModifyDNResult
       extends GenericResult
{
  /**
   * Retrieves the entry as it appeared before the modify DN operation, if
   * available.
   *
   * @return  The entry as it appeared before the modify DN operation, or
   *          {@code null} if it is not available.
   */
  Entry getOldEntry();



  /**
   * Retrieves the entry is it appeared after the modify DN operation, if
   * available.
   *
   * @return  The entry as it appeared after the modify DN operation, or
   *          {@code null} if it is not available.
   */
  Entry getNewEntry();



  /**
   * Retrieves the assured replication requirements that will be used for this
   * operation, if any.
   *
   * @return  The assured replication requirements that will be used for this
   *          operation, or {@code null} if no assurance will be provided for
   *          this operation.
   */
  AssuredReplicationRequirements getAssuredReplicationRequirements();
}