directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r469970 - /directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java
Date Wed, 01 Nov 2006 16:29:27 GMT
Author: elecharny
Date: Wed Nov  1 08:29:26 2006
New Revision: 469970

URL: http://svn.apache.org/viewvc?view=rev&rev=469970
Log:
Fixed javadoc

Modified:
    directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java

Modified: directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java
URL: http://svn.apache.org/viewvc/directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java?view=diff&rev=469970&r1=469969&r2=469970
==============================================================================
--- directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java
(original)
+++ directory/branches/shared/0.9.5/ldap/src/main/java/org/apache/directory/shared/ldap/message/SearchRequest.java
Wed Nov  1 08:29:26 2006
@@ -44,7 +44,7 @@
      * complete however before then it can return search entry, search
      * reference, and extended responses to the client.
      * 
-     * @see getResponseTypes()
+     * @see #getResponseTypes()
      */
     MessageTypeEnum[] RESPONSE_TYPES =
         { SearchResponseDone.TYPE, SearchResponseEntry.TYPE, SearchResponseReference.TYPE,
ExtendedResponse.TYPE };
@@ -54,7 +54,7 @@
      * Gets the different response types generated by a search request.
      * 
      * @return the RESPONSE_TYPES array
-     * @see RESPONSE_TYPES
+     * @see #RESPONSE_TYPES
      */
     MessageTypeEnum[] getResponseTypes();
 
@@ -70,8 +70,7 @@
     /**
      * Sets the search base as a distinguished name.
      * 
-     * @param a_baseDn
-     *            the search base
+     * @param baseDn the search base
      */
     void setBase( LdapDN baseDn );
 
@@ -87,10 +86,9 @@
     /**
      * Sets the search scope parameter enumeration.
      * 
-     * @param a_scope
-     *            the scope enumeration parameter.
+     * @param scope the scope enumeration parameter.
      */
-    void setScope( ScopeEnum a_scope );
+    void setScope( ScopeEnum scope );
 
 
     /**
@@ -104,10 +102,10 @@
     /**
      * Sets the alias handling parameter.
      * 
-     * @param a_derefAliases
+     * @param derefAliases
      *            the alias handling parameter enumeration.
      */
-    void setDerefAliases( DerefAliasesEnum a_derefAliases );
+    void setDerefAliases( DerefAliasesEnum derefAliases );
 
 
     /**
@@ -127,10 +125,10 @@
      * that no client-requested sizelimit restrictions are in effect for the
      * search. Servers may enforce a maximum number of entries to return.
      * 
-     * @param a_entriesMax
+     * @param entriesMax
      *            maximum search result entries to return.
      */
-    void setSizeLimit( int a_entriesMax );
+    void setSizeLimit( int entriesMax );
 
 
     /**
@@ -148,10 +146,10 @@
      * for a search. A value of 0 in this field indicates that no client-
      * requested timelimit restrictions are in effect for the search.
      * 
-     * @param a_secondsMax
+     * @param secondsMax
      *            the search time limit in seconds.
      */
-    void setTimeLimit( int a_secondsMax );
+    void setTimeLimit( int secondsMax );
 
 
     /**
@@ -171,10 +169,10 @@
      * causes only attribute types (no values) to be returned. Setting this
      * field to FALSE causes both attribute types and values to be returned.
      * 
-     * @param a_typesOnly
+     * @param typesOnly
      *            true for only types, false for types and values.
      */
-    void setTypesOnly( boolean a_typesOnly );
+    void setTypesOnly( boolean typesOnly );
 
 
     /**
@@ -188,11 +186,11 @@
     /**
      * Sets the search filter associated with this search request.
      * 
-     * @param a_filter
+     * @param filter
      *            the expression node for the root of the filter expression
      *            tree.
      */
-    void setFilter( ExprNode a_filter );
+    void setFilter( ExprNode filter );
 
 
     /**
@@ -223,17 +221,17 @@
     /**
      * Adds an attribute to the set of entry attributes to return.
      * 
-     * @param a_attribute
+     * @param attribute
      *            the attribute description or identifier.
      */
-    void addAttribute( String a_attribute );
+    void addAttribute( String attribute );
 
 
     /**
      * Removes an attribute to the set of entry attributes to return.
      * 
-     * @param a_attribute
+     * @param attribute
      *            the attribute description or identifier.
      */
-    void removeAttribute( String a_attribute );
+    void removeAttribute( String attribute );
 }



Mime
View raw message