javax.naming.directory

Class SearchControls

Implemented Interfaces:
Serializable

public class SearchControls
extends Object
implements Serializable

See Also:
Serialized Form

Field Summary

static int
OBJECT_SCOPE
static int
ONELEVEL_SCOPE
static int
SUBTREE_SCOPE

Constructor Summary

SearchControls()
The basic constructor.
SearchControls(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref)

Method Summary

long
getCountLimit()
boolean
getDerefLinkFlag()
String[]
getReturningAttributes()
boolean
getReturningObjFlag()
int
getSearchScope()
int
getTimeLimit()
void
setCountLimit(long limit)
void
setDerefLinkFlag(boolean on)
void
setReturningAttributes(String[] attrs)
void
setReturningObjFlag(boolean on)
void
setSearchScope(int scope)
void
setTimeLimit(int ms)

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OBJECT_SCOPE

public static final int OBJECT_SCOPE
Field Value:
0

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE
Field Value:
1

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE
Field Value:
2

Constructor Details

SearchControls

public SearchControls()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

SearchControls

public SearchControls(int scope,
                      long countlim,
                      int timelim,
                      String[] attrs,
                      boolean retobj,
                      boolean deref)

Method Details

getCountLimit

public long getCountLimit()

getDerefLinkFlag

public boolean getDerefLinkFlag()

getReturningAttributes

public String[] getReturningAttributes()

getReturningObjFlag

public boolean getReturningObjFlag()

getSearchScope

public int getSearchScope()

getTimeLimit

public int getTimeLimit()

setCountLimit

public void setCountLimit(long limit)

setDerefLinkFlag

public void setDerefLinkFlag(boolean on)

setReturningAttributes

public void setReturningAttributes(String[] attrs)

setReturningObjFlag

public void setReturningObjFlag(boolean on)

setSearchScope

public void setSearchScope(int scope)

setTimeLimit

public void setTimeLimit(int ms)

SearchControls.java -- Copyright (C) 2001, 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.