001 /* SearchControls.java --
002 Copyright (C) 2001, 2004, 2005, 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.naming.directory;
040
041 import java.io.Serializable;
042
043 /**
044 * @author Warren Levy (warrenl@redhat.com)
045 * @date June 5, 2001
046 */
047
048 public class SearchControls implements Serializable
049 {
050 private static final long serialVersionUID = - 2480540967773454797L;
051 public static final int OBJECT_SCOPE = 0;
052 public static final int ONELEVEL_SCOPE = 1;
053 public static final int SUBTREE_SCOPE = 2;
054
055 // Serialized fields.
056 private int searchScope;
057 private int timeLimit;
058 private boolean derefLink;
059 private boolean returnObj;
060 private long countLimit;
061 private String[] attributesToReturn;
062
063 public SearchControls()
064 {
065 this(ONELEVEL_SCOPE, 0L, 0, null, false, false);
066 }
067
068 public SearchControls(int scope, long countlim, int timelim, String[] attrs,
069 boolean retobj, boolean deref)
070 {
071 searchScope = scope;
072 timeLimit = timelim;
073 derefLink = deref;
074 returnObj = retobj;
075 countLimit = countlim;
076 attributesToReturn = attrs;
077 }
078
079 public int getSearchScope()
080 {
081 return searchScope;
082 }
083
084 public int getTimeLimit()
085 {
086 return timeLimit;
087 }
088
089 public boolean getDerefLinkFlag()
090 {
091 return derefLink;
092 }
093
094 public boolean getReturningObjFlag()
095 {
096 return returnObj;
097 }
098
099 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 }