Package org.ldaptive.templates
Class Query
java.lang.Object
org.ldaptive.templates.Query
Contains data associated with a query request.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String[]
Used for setting empty terms.private Integer
Start index of search results to return.private String[]
Attributes to return with the ldap query.private String
Additional restrictions to place on every query.private final String[]
Query separated into terms.private Integer
End index of search results to return. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the from result.String[]
Returns the return attributes.Returns the search restrictions.String[]
getTerms()
Returns the terms.Returns the to result.void
Sets the index of the result to begin searching.void
setReturnAttributes
(String[] attrs) Sets the return attributes.void
setSearchRestrictions
(String restrictions) Sets the search restrictions.void
Sets the index of the result to stop searching.toString()
-
Field Details
-
EMPTY_STRING_ARRAY
Used for setting empty terms. -
terms
Query separated into terms. -
returnAttributes
Attributes to return with the ldap query. -
searchRestrictions
Additional restrictions to place on every query. -
fromResult
Start index of search results to return. -
toResult
End index of search results to return.
-
-
Constructor Details
-
Query
Parses the query from a string into query terms.- Parameters:
query
- to parse
-
-
Method Details
-
getTerms
Returns the terms.- Returns:
- query terms
-
setReturnAttributes
Sets the return attributes.- Parameters:
attrs
- return attributes
-
getReturnAttributes
Returns the return attributes.- Returns:
- return attributes
-
setSearchRestrictions
Sets the search restrictions.- Parameters:
restrictions
- search restrictions
-
getSearchRestrictions
Returns the search restrictions.- Returns:
- search restrictions
-
setFromResult
Sets the index of the result to begin searching.- Parameters:
i
- from index
-
getFromResult
Returns the from result.- Returns:
- from result
-
setToResult
Sets the index of the result to stop searching.- Parameters:
i
- to result
-
getToResult
Returns the to result.- Returns:
- to result
-
toString
-