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 java.lang.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(java.util.Date from, java.util.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.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 DateRangeQuery.DateRangeQueryType getDateRangeQueryType()
           
 java.util.Date getFromDate()
           
 java.lang.String getKey()
           
 java.util.List getParameters()
          List of parameters as Strings or SearchQuerys.
 java.util.Date getToDate()
           
 int hashCode()
           
 boolean isIncludeFrom()
           
 boolean isIncludeTo()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DateRangeQuery

public DateRangeQuery(@Nullable
                      java.util.Date from,
                      @Nullable
                      java.util.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(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

getKey

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

getParameters

public java.util.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 java.util.Date getFromDate()

getToDate

public java.util.Date getToDate()

isIncludeFrom

public boolean isIncludeFrom()

isIncludeTo

public boolean isIncludeTo()

getDateRangeQueryType

public DateRangeQuery.DateRangeQueryType getDateRangeQueryType()

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2003-2013 Atlassian. All Rights Reserved.