com.atlassian.confluence.search.v2.query
Class DateRangeQuery

java.lang.Object
  extended by com.atlassian.confluence.search.v2.query.DateRangeQuery
All Implemented Interfaces:
SearchQuery

public class DateRangeQuery
extends Object
implements SearchQuery

Query for search results that have been modified within the specified range of dates.


Nested Class Summary
static class DateRangeQuery.Builder
          Helps create a DateRangeQuery object
static class DateRangeQuery.DateRange
          Class to represent a date range.
static class DateRangeQuery.DateRangeQueryType
           
 
Constructor Summary
DateRangeQuery(Date from, Date to, boolean includeFrom, boolean includeTo, 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)
           
DateRangeQuery(DateRangeQuery.DateRange dateRange, DateRangeQuery.DateRangeQueryType dateRangeQueryType)
          Query for search results that have been modified within the specified range of dates.
 
Method Summary
 boolean equals(Object obj)
           
 DateRangeQuery.DateRangeQueryType getDateRangeQueryType()
          Deprecated. since 5.7 use getQueryType()
 com.atlassian.fugue.Option<String> getFieldName()
           
 Date getFromDate()
           
 String getKey()
           
 List getParameters()
          List of parameters as Strings or SearchQuerys.
 com.atlassian.fugue.Option<DateRangeQuery.DateRangeQueryType> getQueryType()
           
 Date getToDate()
           
 int hashCode()
           
 boolean isIncludeFrom()
           
 boolean isIncludeTo()
           
static DateRangeQuery.Builder newDateRangeQuery(DateRangeQuery.DateRangeQueryType type)
           
static DateRangeQuery.Builder newDateRangeQuery(String fieldName)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 range
includeTo - include the end date in the range
dateRangeQueryType - the type of range query. See DateRangeQuery.DateRangeQueryType

DateRangeQuery

public DateRangeQuery(Date fromDate,
                      Date toDate,
                      boolean includeFrom,
                      boolean includeTo,
                      String fieldName)

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. See DateRangeQuery.DateRange
dateRangeQueryType - the type of range query. See DateRangeQuery.DateRangeQueryType
Method Detail

newDateRangeQuery

public static DateRangeQuery.Builder newDateRangeQuery(DateRangeQuery.DateRangeQueryType type)

newDateRangeQuery

public static DateRangeQuery.Builder newDateRangeQuery(String fieldName)

getKey

public String getKey()
Specified by:
getKey in interface SearchQuery
Returns:
the plugin key

getParameters

public List getParameters()
Description copied from interface: SearchQuery
List of parameters as Strings or SearchQuerys.

Specified by:
getParameters in interface SearchQuery
Returns:
Strings or SearchQuerys.

getFromDate

public Date getFromDate()

getToDate

public Date getToDate()

isIncludeFrom

public boolean isIncludeFrom()

isIncludeTo

public boolean isIncludeTo()

getDateRangeQueryType

@Deprecated
public DateRangeQuery.DateRangeQueryType getDateRangeQueryType()
Deprecated. since 5.7 use getQueryType()


getQueryType

public com.atlassian.fugue.Option<DateRangeQuery.DateRangeQueryType> getQueryType()

getFieldName

public com.atlassian.fugue.Option<String> getFieldName()

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2003–2015 Atlassian. All rights reserved.