|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.tools.LDAPToolOptions
org.opends.server.tools.LDAPSearchOptions
public class LDAPSearchOptions
This class defines options for the search operations used by the ldapsearch tool.
Constructor Summary | |
---|---|
LDAPSearchOptions()
Creates the options instance. |
Method Summary | |
---|---|
boolean |
countMatchingEntries()
Indicates whether to report the number of matching entries returned by the server. |
DereferencePolicy |
getDereferencePolicy()
Return the dereference policy. |
SearchScope |
getSearchScope()
Get the search scope value. |
int |
getSizeLimit()
Return the sizeLimit value. |
int |
getTimeLimit()
Return the timeLimit value. |
boolean |
getTypesOnly()
Return only the attribute types in the search result. |
void |
setCountMatchingEntries(boolean countMatchingEntries)
Specifies whether to report the number of matching entries returned by the server. |
boolean |
setDereferencePolicy(java.lang.String policy,
java.io.PrintStream err)
Set the dereference policy. |
boolean |
setSearchScope(java.lang.String scope,
java.io.PrintStream err)
Set the search scope . |
void |
setSizeLimit(int sizeLimit)
Set the sizeLimit for the operation. |
void |
setTimeLimit(int timeLimit)
Set the timeLimit for the operation. |
void |
setTypesOnly(boolean typesOnly)
Return only the attribute types in the search result. |
Methods inherited from class org.opends.server.tools.LDAPToolOptions |
---|
continueOnError, getControls, getEncoding, getVerbose, setContinueOnError, setControls, setEncoding, setShowOperations, setVerbose, showOperations |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LDAPSearchOptions()
Method Detail |
---|
public void setTimeLimit(int timeLimit)
timeLimit
- The time limit for the search.public int getTimeLimit()
public void setSizeLimit(int sizeLimit)
sizeLimit
- The size limit for the search.public int getSizeLimit()
public boolean setSearchScope(java.lang.String scope, java.io.PrintStream err)
scope
- The search scope string.err
- A print stream to which error messages should be written if
a problem occurs.
true
if the scope was set properly, or
false
if not.public SearchScope getSearchScope()
public boolean setDereferencePolicy(java.lang.String policy, java.io.PrintStream err)
policy
- The dereference policy.err
- A print stream to which error messages should be written if
a problem occurs.
true
if the dereference policy was set properly, or
false
if not.public DereferencePolicy getDereferencePolicy()
public boolean getTypesOnly()
true
if only attribute types should be returned in
matching entries, or false
if both types and values
should be included.public void setTypesOnly(boolean typesOnly)
typesOnly
- Specifies whether only attribute types should be
returned in matching entries, or both types and values.public boolean countMatchingEntries()
true
if the number of matching entries should be reported,
or false
if not.public void setCountMatchingEntries(boolean countMatchingEntries)
countMatchingEntries
- Specifies whether to report the number of
matching entries returned by the server.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |