public class LDAPSearchOptions extends LDAPToolOptions
Constructor and Description |
---|
LDAPSearchOptions()
Creates the options instance.
|
Modifier and Type | Method and Description |
---|---|
boolean |
countMatchingEntries()
Indicates whether to report the number of matching entries returned by the
server.
|
org.forgerock.opendj.ldap.DereferenceAliasesPolicy |
getDereferencePolicy()
Return the dereference policy.
|
org.forgerock.opendj.ldap.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(String policy,
PrintStream err)
Set the dereference policy.
|
boolean |
setSearchScope(String scope,
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.
|
continueOnError, getControls, getEncoding, getVerbose, setContinueOnError, setControls, setEncoding, setShowOperations, setVerbose, showOperations
public LDAPSearchOptions()
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(String scope, 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 org.forgerock.opendj.ldap.SearchScope getSearchScope()
public boolean setDereferencePolicy(String policy, 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 org.forgerock.opendj.ldap.DereferenceAliasesPolicy 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.Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.