Package ch.ivyteam.ivy.business.data.store.search

Interface DateTimeFieldOperation<T>

Type Parameters:

T -

All Superinterfaces:

FieldOperation<T>

public interface DateTimeFieldOperation<T>
extends FieldOperation<T>

Operations to filter DateTime fields

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
Filter<T>	isAfter(Date value)	Matches DateTime values that are after the given value
Filter<T>	isAfterOrEqualTo(Date value)	Matches DateTime values that are after or equal to the given value
Filter<T>	isBefore(Date value)	Matches DateTime values that are before the given value
Filter<T>	isBeforeOrEqualTo(Date value)	Matches DateTime values that are before or equal to the given value
Filter<T>	isBetween(Date fromExclusive, Date toExclusive)	Matches DateTime values that are between the given values (exclusive)
Filter<T>	isEqualTo(Date value)	Matches DateTime values that are equal to the given value
Filter<T>	isInDateRange(Date fromDateOnlyInclusive, Date toDateOnlyInclusive)	Matches DateTime values that are in the range of the given Date values (inclusive).

Method Detail

isEqualTo

Filter<T> isEqualTo(Date value)

Matches DateTime values that are equal to the given value

Parameters:

value -

Returns:

filter, orderBy, limit, execute operations

See Also:

isBetween(Date, Date), isInDateRange(Date, Date)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

isBefore

Filter<T> isBefore(Date value)

Matches DateTime values that are before the given value

Parameters:

value -

Returns:

filter, orderBy, limit, execute operations

See Also:

isBeforeOrEqualTo(Date), isAfter(Date), isAfterOrEqualTo(Date), isBetween(Date, Date)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

isBeforeOrEqualTo

Filter<T> isBeforeOrEqualTo(Date value)

Matches DateTime values that are before or equal to the given value

Parameters:

value -

Returns:

filter, orderBy, limit, execute operations

See Also:

isBefore(Date), isAfter(Date), isAfterOrEqualTo(Date), isBetween(Date, Date)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

isAfter

Filter<T> isAfter(Date value)

Matches DateTime values that are after the given value

Parameters:

value -

Returns:

filter, orderBy, limit, execute operations

See Also:

isAfterOrEqualTo(Date), isBefore(Date), isBeforeOrEqualTo(Date), isBetween(Date, Date)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

isAfterOrEqualTo

Filter<T> isAfterOrEqualTo(Date value)

Matches DateTime values that are after or equal to the given value

Parameters:

value -

Returns:

filter, orderBy, limit, execute operations

See Also:

isAfter(Date), isBefore(Date), isBeforeOrEqualTo(Date), isBetween(Date, Date)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

isBetween

Filter<T> isBetween(Date fromExclusive,
                    Date toExclusive)

Matches DateTime values that are between the given values (exclusive)

Parameters:

fromExclusive -

toExclusive -

Returns:

filter, orderBy, limit, execute operations

See Also:

isInDateRange(Date, Date), isBefore(Date), isBeforeOrEqualTo(Date), isAfter(Date), isAfterOrEqualTo(Date)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

isInDateRange

Filter<T> isInDateRange(Date fromDateOnlyInclusive,
                        Date toDateOnlyInclusive)

Matches DateTime values that are in the range of the given Date values (inclusive).

Example:

 Date today = new Date();

 // result contains all log entries from today 00:00:00 to 23:59:59
 List<LogEntry> result = ivy.repo.search(LogEntry.class).dateField("timestamp").isInDateRange(today, today).execute().getAll();
 

Parameters:

fromDateOnlyInclusive - lower inclusive boundary. Only the date part is considered.

toDateOnlyInclusive - higher inclusive boundary. Only the date part is considered.

Returns:

filter, orderBy, limit, execute operations

See Also:

isBetween(Date, Date), isBefore(Date), isBeforeOrEqualTo(Date), isAfter(Date), isAfterOrEqualTo(Date)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.