|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DateFilter
A DateFilter
object is used to sort according to date ranges.
Date filtering can be used between two dates
by calling the greaterThan()
and lessThan()
methods.
Method Summary | |
---|---|
void |
greaterThan(java.util.Date date,
boolean inclusive)
Sets a search filter for a date that is greater than or possibly equal to the supplied date (depending on the value of the inclusive parameter). |
void |
lessThan(java.util.Date date,
boolean inclusive)
Sets a search filter for a date that is less than or possibly equal to the supplied date (depending on the value of the inclusive parameter). |
void |
setGreaterThanDate(java.util.Date greaterThanDate)
Sets a search filter for a date that is greater than or possibly equal to the supplied date (depending on the value of the greaterThanInclusive value which can be set by the
#setGreaterThanInclusive() method). |
void |
setGreaterThanInclusive(boolean greaterThanInclusive)
Sets a boolean flag indicating if the date set in the #setGreaterThanDate() method
should be included in the query or only all dates greater than the set date. |
void |
setLessThanDate(java.util.Date lessThanDate)
Sets a search filter for a date that is less than or possibly equal to the supplied date (depending on the value of the lessThanInclusive value which can be set by the
#setLessThanInclusive() method). |
void |
setLessThanInclusive(boolean lessThanInclusive)
Sets a boolean flag indicating if the date set in the #setGreaterThanDate() method
should be included in the query or only all dates greater than the set date. |
Method Detail |
---|
void greaterThan(java.util.Date date, boolean inclusive)
inclusive
parameter).
This method may be used by itself or with the lessThan()
method.
When both methods are used together, they will be logically AND
-ed.
date
- The date used in the search filter.inclusive
- Specifies whether to include the date in the filter.
true
is specified to include the date, and
false
is specified for dates that are strictly greater than the date.void lessThan(java.util.Date date, boolean inclusive)
inclusive
parameter).
This method may be used by itself or with the greaterThan()
method.
When both methods are used together, they will be logically AND
-ed.
date
- The date used in the search filter.inclusive
- Specifies whether to include the date in the filter.
true
is specified to include the date, and
false
is specified for dates that are strictly less than the date.void setGreaterThanDate(java.util.Date greaterThanDate)
greaterThanInclusive
value which can be set by the
#setGreaterThanInclusive()
method).
This method may be used by itself or with the #setLessThanDate()
method.
When both methods are used together, they will be logically AND
-ed.
greaterThanDate
- The date used in the search filter.
true
is specified to include the date, and
false
is specified for dates that are strictly greater than the date.void setLessThanDate(java.util.Date lessThanDate)
lessThanInclusive
value which can be set by the
#setLessThanInclusive()
method).
This method may be used by itself or with the #setGreaterThanDate()
method.
When both methods are used together, they will be logically AND
-ed.
lessThanDate
- The date used in the search filter.
true
is specified to include the date, and
false
is specified for dates that are strictly less than the date.void setGreaterThanInclusive(boolean greaterThanInclusive)
#setGreaterThanDate()
method
should be included in the query or only all dates greater than the set date.
greaterThanInclusive
- A flag indicating if set date should be included in the query.
true
is specified to include the date, and
false
is specified for dates that are strictly greater than the date.void setLessThanInclusive(boolean lessThanInclusive)
#setGreaterThanDate()
method
should be included in the query or only all dates greater than the set date.
lessThanInclusive
- A flag indicating if set date should be included in the query.
true
is specified to include the date, and
false
is specified for dates that are strictly less than the date.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |