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.DN; 032 import com.unboundid.ldap.sdk.RDN; 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 update a modify 041 * DN request. 042 */ 043 @NotExtensible() 044 @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 045 public interface UpdatableModifyDNRequest 046 extends ModifyDNRequest, UpdatableRequest 047 { 048 /** 049 * Specifies the DN of the entry to move and/or rename. 050 * 051 * @param dn The DN of the entry to move and/or rename. It must not be 052 * {@code null}. 053 */ 054 void setDN(final String dn); 055 056 057 058 /** 059 * Specifies the DN of the entry to move and/or rename. 060 * 061 * @param dn The DN of the entry to move and/or rename. It must not be 062 * {@code null}. 063 */ 064 void setDN(final DN dn); 065 066 067 068 /** 069 * Specifies the new RDN to use for the entry. 070 * 071 * @param newRDN The new RDN to use for the entry. It must not be 072 * {@code null}. 073 */ 074 void setNewRDN(final String newRDN); 075 076 077 078 /** 079 * Specifies the new RDN to use for the entry. 080 * 081 * @param newRDN The new RDN to use for the entry. It must not be 082 * {@code null}. 083 */ 084 void setNewRDN(final RDN newRDN); 085 086 087 088 /** 089 * Specifies whether to remove the old RDN values from the entry. 090 * 091 * @param deleteOldRDN Indicates whether to remove the old RDN values from 092 * the entry. 093 */ 094 void setDeleteOldRDN(final boolean deleteOldRDN); 095 096 097 098 /** 099 * Specifies the DN for the new superior entry, if any. 100 * 101 * @param newSuperiorDN The DN for the new superior entry. It may be 102 * {@code null} if the entry should remain below its 103 * current parent. 104 */ 105 void setNewSuperiorDN(final String newSuperiorDN); 106 107 108 109 /** 110 * Specifies the DN for the new superior entry, if any. 111 * 112 * @param newSuperiorDN The DN for the new superior entry. It may be 113 * {@code null} if the entry should remain below its 114 * current parent. 115 */ 116 void setNewSuperiorDN(final DN newSuperiorDN); 117 }