Class DateRangeQuery
java.lang.Object
com.atlassian.confluence.search.v2.query.DateRangeQuery
- All Implemented Interfaces:
Expandable<SearchQuery>
,SearchQuery
Query for search results that have been modified within the specified range of dates.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Helps create aDateRangeQuery
objectstatic class
Deprecated.static enum
-
Field Summary
Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery
DEFAULT_BOOST
-
Constructor Summary
ConstructorDescriptionDateRangeQuery
(@Nullable Date from, @Nullable Date to, boolean includeFrom, boolean includeTo, DateRangeQuery.DateRangeQueryType dateRangeQueryType) Query for search results that have been modified within the specified range of dates.DateRangeQuery
(DateRangeQuery.DateRange dateRange, DateRangeQuery.DateRangeQueryType dateRangeQueryType) Query for search results that have been modified within the specified range of dates.DateRangeQuery
(Date fromDate, Date toDate, boolean includeFrom, boolean includeTo, String fieldName) -
Method Summary
Modifier and TypeMethodDescriptionboolean
expand()
Expands this query into a composite query (that composes other queries).getKey()
List of parameters asString
s orSearchQuery
s.int
hashCode()
boolean
boolean
static DateRangeQuery.Builder
static DateRangeQuery.Builder
newDateRangeQuery
(String fieldName) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery
getBoost, getSubClauses
-
Constructor Details
-
DateRangeQuery
public DateRangeQuery(@Nullable Date from, @Nullable Date to, boolean includeFrom, boolean includeTo, DateRangeQuery.DateRangeQueryType dateRangeQueryType) Query for search results that have been modified within the specified range of dates.- Parameters:
from
- the beginning of the date range (can be null)to
- the end date in the range (can be null)includeFrom
- include the beginning date in the rangeincludeTo
- include the end date in the rangedateRangeQueryType
- the type of range query. SeeDateRangeQuery.DateRangeQueryType
-
DateRangeQuery
-
DateRangeQuery
public DateRangeQuery(DateRangeQuery.DateRange dateRange, DateRangeQuery.DateRangeQueryType dateRangeQueryType) Query for search results that have been modified within the specified range of dates.- Parameters:
dateRange
- the dateRange. SeeDateRangeQuery.DateRange
dateRangeQueryType
- the type of range query. SeeDateRangeQuery.DateRangeQueryType
-
-
Method Details
-
newDateRangeQuery
-
newDateRangeQuery
-
getKey
- Specified by:
getKey
in interfaceSearchQuery
- Returns:
- the plugin key
-
getParameters
Description copied from interface:SearchQuery
List of parameters asString
s orSearchQuery
s.- Specified by:
getParameters
in interfaceSearchQuery
- Returns:
String
s orSearchQuery
s.
-
getFromDate
-
getToDate
-
isIncludeFrom
public boolean isIncludeFrom() -
isIncludeTo
public boolean isIncludeTo() -
queryType
- Since:
- 7.0.1
-
fieldName
- Since:
- 7.0.1
-
expand
Description copied from interface:SearchQuery
Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.- Specified by:
expand
in interfaceExpandable<SearchQuery>
- Specified by:
expand
in interfaceSearchQuery
- Returns:
- a query
-
equals
-
hashCode
public int hashCode()
-
Range
instead