public final class JSONStoreFindOptions
extends java.lang.Object
Constructor and Description |
---|
JSONStoreFindOptions() |
Modifier and Type | Method and Description |
---|---|
void |
addSearchFilter(java.lang.String new_filter)
Add a search filter to the existing list of search fields.
|
java.lang.Integer |
getLimit()
Get the maximum number of results as configured.
|
java.lang.Integer |
getOffset()
Get the offset index of the results as configured.
|
void |
includeDeletedDocuments(boolean include)
Modify the flag to include deleted documents or to not include deleted documents.
|
void |
setLimit(java.lang.Integer limit)
Specify the maximum number of results to be returned.
|
void |
setOffset(java.lang.Integer offset)
Set the offset of which results will begin.
|
void |
setSearchFilters(java.util.List filters)
Set the search fields to be returned on the results of the find operation.
|
boolean |
shouldIncludeDeletedDocuments()
Retrieve the flag that determines if the result should include deleted documents or not include deleted documents.
|
void |
sortBySearchFieldAscending(java.lang.String search_field)
Add a new search field by which the results will be sorted.
|
void |
sortBySearchFieldDescending(java.lang.String search_field)
Add a new search field by which the results will be sorted.
|
public void setLimit(java.lang.Integer limit)
limit
- public java.lang.Integer getLimit()
public void setOffset(java.lang.Integer offset)
offset
- The index at where the documents returned will begin.public java.lang.Integer getOffset()
public void sortBySearchFieldAscending(java.lang.String search_field)
search_field
- The search field that is used for a ascending sort.public void sortBySearchFieldDescending(java.lang.String search_field)
search_field
- The search field that is used for a descending sort.public void setSearchFilters(java.util.List filters)
filters
- array of Strings with the names of the search fields or additional search fields that will be returned.public void addSearchFilter(java.lang.String new_filter)
new_filter
- Add a new search field that must be included in the find results.public void includeDeletedDocuments(boolean include)
include
- When true, documents marked 'deleted' will be included in the find.public boolean shouldIncludeDeletedDocuments()
© Copyright IBM Corp. 2006, 2015. All Rights Reserved.