Source for javax.naming.directory.SearchControls

   1: /* SearchControls.java --
   2:    Copyright (C) 2001, 2004, 2005, 2006  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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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:   private static final long serialVersionUID = - 2480540967773454797L;
  51:   public static final int OBJECT_SCOPE = 0;
  52:   public static final int ONELEVEL_SCOPE = 1;
  53:   public static final int SUBTREE_SCOPE = 2;
  54: 
  55:   // Serialized fields.
  56:   private int searchScope;
  57:   private int timeLimit;
  58:   private boolean derefLink;
  59:   private boolean returnObj;
  60:   private long countLimit;
  61:   private String[] attributesToReturn;
  62: 
  63:   public SearchControls()
  64:   {
  65:     this(ONELEVEL_SCOPE, 0L, 0, null, false, false);
  66:   }
  67: 
  68:   public SearchControls(int scope, long countlim, int timelim, String[] attrs,
  69:               boolean retobj, boolean deref)
  70:   {
  71:     searchScope = scope;
  72:     timeLimit = timelim;
  73:     derefLink = deref;
  74:     returnObj = retobj;
  75:     countLimit = countlim;
  76:     attributesToReturn = attrs;
  77:   }
  78: 
  79:   public int getSearchScope()
  80:   {
  81:     return searchScope;
  82:   }
  83: 
  84:   public int getTimeLimit()
  85:   {
  86:     return timeLimit;
  87:   }
  88: 
  89:   public boolean getDerefLinkFlag()
  90:   {
  91:     return derefLink;
  92:   }
  93: 
  94:   public boolean getReturningObjFlag()
  95:   {
  96:     return returnObj;
  97:   }
  98: 
  99:   public long getCountLimit()
 100:   {
 101:     return countLimit;
 102:   }
 103: 
 104:   public String[] getReturningAttributes()
 105:   {
 106:     return attributesToReturn;
 107:   }
 108: 
 109:   public void setSearchScope(int scope)
 110:   {
 111:     searchScope = scope;
 112:   }
 113: 
 114:   public void setTimeLimit(int ms)
 115:   {
 116:     timeLimit = ms;
 117:   }
 118: 
 119:   public void setDerefLinkFlag(boolean on)
 120:   {
 121:     derefLink = on;
 122:   }
 123: 
 124:   public void setReturningObjFlag(boolean on)
 125:   {
 126:     returnObj = on;
 127:   }
 128: 
 129:   public void setCountLimit(long limit)
 130:   {
 131:     countLimit = limit;
 132:   }
 133: 
 134:   public void setReturningAttributes(String[] attrs)
 135:   {
 136:     attributesToReturn = attrs;
 137:   }
 138: }