libjava/javax/naming/directory/SearchControls.java

   1 /* SearchControls.java --
   2    Copyright (C) 2001, 2004, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.naming.directory;
  40
  41 import java.io.Serializable;
  42
  43 /**
  44  * @author Warren Levy (warrenl@redhat.com)
  45  * @date June 5, 2001
  46  */
  47
  48 public class SearchControls implements Serializable
  49 {
  50   public static final int OBJECT_SCOPE = 0;
  51   public static final int ONELEVEL_SCOPE = 1;
  52   public static final int SUBTREE_SCOPE = 2;
  53
  54   // Serialized fields.
  55   private int searchScope;
  56   private int timeLimit;
  57   private boolean derefLink;
  58   private boolean returnObj;
  59   private long countLimit;
  60   private String[] attributesToReturn;
  61
  62   public SearchControls()
  63   {
  64     this(ONELEVEL_SCOPE, 0L, 0, null, false, false);
  65   }
  66
  67   public SearchControls(int scope, long countlim, int timelim, String[] attrs,
  68                         boolean retobj, boolean deref)
  69   {
  70     searchScope = scope;
  71     timeLimit = timelim;
  72     derefLink = deref;
  73     returnObj = retobj;
  74     countLimit = countlim;
  75     attributesToReturn = attrs;
  76   }
  77
  78   public int getSearchScope()
  79   {
  80     return searchScope;
  81   }
  82
  83   public int getTimeLimit()
  84   {
  85     return timeLimit;
  86   }
  87
  88   public boolean getDerefLinkFlag()
  89   {
  90     return derefLink;
  91   }
  92
  93   public boolean getReturningObjFlag()
  94   {
  95     return returnObj;
  96   }
  97
  98   public long getCountLimit()
  99   {
 100     return countLimit;
 101   }
 102
 103   public String[] getReturningAttributes()
 104   {
 105     return attributesToReturn;
 106   }
 107
 108   public void setSearchScope(int scope)
 109   {
 110     searchScope = scope;
 111   }
 112
 113   public void setTimeLimit(int ms)
 114   {
 115     timeLimit = ms;
 116   }
 117
 118   public void setDerefLinkFlag(boolean on)
 119   {
 120     derefLink = on;
 121   }
 122
 123   public void setReturningObjFlag(boolean on)
 124   {
 125     returnObj = on;
 126   }
 127
 128   public void setCountLimit(long limit)
 129   {
 130     countLimit = limit;
 131   }
 132
 133   public void setReturningAttributes(String[] attrs)
 134   {
 135     attributesToReturn = attrs;
 136   }
 137 }