directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1156985 - /directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/shared/ldap/extras/controls/SyncModifyDn.java
Date Fri, 12 Aug 2011 06:51:24 GMT
Author: elecharny
Date: Fri Aug 12 06:51:24 2011
New Revision: 1156985

URL: http://svn.apache.org/viewvc?rev=1156985&view=rev
Log:
Added missing Javadoc

Modified:
    directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/shared/ldap/extras/controls/SyncModifyDn.java

Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/shared/ldap/extras/controls/SyncModifyDn.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/shared/ldap/extras/controls/SyncModifyDn.java?rev=1156985&r1=1156984&r2=1156985&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/shared/ldap/extras/controls/SyncModifyDn.java
(original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/shared/ldap/extras/controls/SyncModifyDn.java
Fri Aug 12 06:51:24 2011
@@ -37,37 +37,66 @@ import org.apache.directory.shared.ldap.
  */
 public interface SyncModifyDn extends Control
 {
-
     /** This control OID */
     public static final String OID = "1.3.6.1.4.1.4203.1.9.1.5";
     
 
+    /**
+     * @return the current entry DN
+     */
     String getEntryDn();
 
 
+    /**
+     * @param entryDn The Entry DN
+     */
     void setEntryDn( String entryDn );
 
 
+    /**
+     * @return The new superior DN if it's a Move or a Move@Rename operation
+     */
     String getNewSuperiorDn();
 
 
+    /**
+     * @param newSuperiorDn Sets the new Superior DN
+     */
     void setNewSuperiorDn( String newSuperiorDn );
 
 
+    /**
+     * @return The new name if it's a Rename or Move&Rename opertion
+     */
     String getNewRdn();
 
 
+    /**
+     * @param newRdn Sets the new name
+     */
     void setNewRdn( String newRdn );
 
 
+    /**
+     * @return true if the attribute associated with the old name is to be removed (rename
operation)
+     */
     boolean isDeleteOldRdn();
 
 
+    /**
+     * @param deleteOldRdn The flag to tell the server to remove the attribute assoicated
with the old name
+     */
     void setDeleteOldRdn( boolean deleteOldRdn );
 
 
+    /**
+     * @return The MODDN operation type
+     */
     SyncModifyDnType getModDnType();
 
 
+    /**
+     * @param modDnType The MODDN operation type
+     */
     void setModDnType( SyncModifyDnType modDnType );
 }
\ No newline at end of file



Mime
View raw message