001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2010-2014 UnboundID Corp. 026 */ 027 package com.unboundid.directory.sdk.common.operation; 028 029 030 031 import com.unboundid.ldap.sdk.ReadOnlyModifyDNRequest; 032 import com.unboundid.ldif.LDIFModifyDNChangeRecord; 033 import com.unboundid.util.NotExtensible; 034 import com.unboundid.util.ThreadSafety; 035 import com.unboundid.util.ThreadSafetyLevel; 036 037 038 039 /** 040 * This interface defines a set of methods which may be used to interact with a 041 * modify DN request. 042 */ 043 @NotExtensible() 044 @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 045 public interface ModifyDNRequest 046 extends ChangeRequest 047 { 048 /** 049 * Retrieves the DN of the entry to move and/or rename. 050 * 051 * @return The DN of the entry to move and/or rename. 052 */ 053 String getDN(); 054 055 056 057 /** 058 * Retrieves the new RDN to use for the entry. 059 * 060 * @return The new RDN to use for the entry. 061 */ 062 String getNewRDN(); 063 064 065 066 /** 067 * Indicates whether to remove the old RDN values from the entry. 068 * 069 * @return {@code true} if the old RDN values should be removed, or 070 * {@code false} if not. 071 */ 072 boolean deleteOldRDN(); 073 074 075 076 /** 077 * Retrieves the DN for the new superior entry, if any. 078 * 079 * @return The DN for the new superior entry, or {@code null} if the entry 080 * should remain below its current parent. 081 */ 082 String getNewSuperiorDN(); 083 084 085 086 /** 087 * Retrieves an LDAP SDK representation of this modify DN request. 088 * 089 * @return An LDAP SDK representation of this modify DN request. 090 */ 091 ReadOnlyModifyDNRequest toLDAPSDKRequest(); 092 093 094 095 /** 096 * Retrieves an LDIF change record that corresponds to this modify DN request. 097 * 098 * @return An LDIF change record that corresponds to this modify DN request. 099 */ 100 LDIFModifyDNChangeRecord toLDIFChangeRecord(); 101 }