Package ch.ivyteam.ivy.workflow.query

Class SignalEventQuery

java.lang.Object

ch.ivyteam.ivy.persistence.query.Query<ISignalEvent>

ch.ivyteam.ivy.workflow.query.SignalEventQuery

Direct Known Subclasses:

SignalEventQuery.AggregationQuery, SignalEventQuery.FilterLink, SignalEventQuery.GroupByQuery, SignalEventQuery.OrderByQuery

public class SignalEventQuery
extends Query<ISignalEvent>

API:

This is a public API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignalEventQuery.AggregationQuery	This class provides methods to perform aggregations on the query.
static class	SignalEventQuery.FilterLink	Links a where condition with another.
static class	SignalEventQuery.FilterQuery
static class	SignalEventQuery.GroupByQuery	Provides methods to group the result by certain fields.
static interface	SignalEventQuery.IAggregationQuery	Provides methods to perform aggregations on the query.
static interface	SignalEventQuery.IBoolFilterQuery
static interface	SignalEventQuery.IColumnFilterQuery	Basic filter functionality provider for a column of ISignalEvent
static interface	SignalEventQuery.IDateColumnFilterQuery	Provides filter functionality for a date column of ISignalEvent
static interface	SignalEventQuery.IFilterableColumns
static interface	SignalEventQuery.IFilterLink	Links a where condition with another.
static interface	SignalEventQuery.IFilterQuery
static interface	SignalEventQuery.IGroupByQueryColumns	Provides methods to group the result by certain fields.
static interface	SignalEventQuery.IIntegerColumnFilterQuery	Provides filter functionality for an integer column of ISignalEvent
static interface	SignalEventQuery.INumberColumnFilterQuery	Provides filter functionality for a decimal number column of ISignalEvent
static interface	SignalEventQuery.IOrderByQueryColumns	Provides methods to order the result by columns of ISignalEvent.
static interface	SignalEventQuery.IPatternColumnFilterQuery	Provides filter functionality for columns of ISignalEvent that can be filter by string patterns (isLike)
static interface	SignalEventQuery.IStringColumnFilterQuery	Provides filter functionality for a string column of ISignalEvent
static class	SignalEventQuery.OrderByColumnQuery	Provides methods to define the direction of the sorting either ascending or descending.
static class	SignalEventQuery.OrderByQuery	Provides methods to order the result by columns of ISignalEvent.

Method Summary

Modifier and Type	Method	Description
SignalEventQuery.IAggregationQuery	aggregate()	Returns an object which contains the aggregation part for this query. It provides methods to perform aggregations on the query.
String	asJson()	Deprecated. Do not serialize and deserialize Query.
static SignalEventQuery	create()	Creates a new query
IFluentQueryExecutor<ISignalEvent>	executor()	Provides a fluent API to execute this query and fetch its results.
static SignalEventQuery	fromJson(String json)	Deprecated. Do not serialize and deserialize SignalEventQuery.
SignalEventQuery.IGroupByQueryColumns	groupBy()	Returns an object which contains the group by part for this query. It provides methods to group the result by certain fields.
SignalEventQuery.IOrderByQueryColumns	orderBy()	Returns an object which contains the order by part for this query. It provides methods to order the result by certain columns.
<T> T	toType(Class<T> clazz)	Deprecated.
SignalEventQuery.IFilterQuery	where()	Returns an object which contains the where part for this query. It provides methods to filter the result by certain columns.

Methods inherited from class ch.ivyteam.ivy.persistence.query.Query

equals, hashCode

Method Details

create

public static SignalEventQuery create()

Creates a new query

Returns:

A new instance of SignalEventQuery

API:

This public API is available in Java.

fromJson

@Deprecated
public static SignalEventQuery fromJson(String json)

Deprecated.

Do not serialize and deserialize SignalEventQuery. There is no guarantee that the serialized form is compatible with each version of ivy.

Creates a new query based on the given JSON. See SignalEventQuery for an example.

Parameters:

json - the serialized SignalEventQuery, generated by asJson()

Returns:

A new instance of SignalEventQuery

API:

This public API is available in Java.

executor

public IFluentQueryExecutor<ISignalEvent> executor()

Provides a fluent API to execute this query and fetch its results.

Returns:

fluent API to execute this query.

API:

This public API is available in Java.

aggregate

public SignalEventQuery.IAggregationQuery aggregate()

Returns an object which contains the aggregation part for this query.
It provides methods to perform aggregations on the query. For each aggregation a column is added to the result set.

Returns:

aggregate query

API:

This public API is available in Java.

groupBy

public SignalEventQuery.IGroupByQueryColumns groupBy()

Returns an object which contains the group by part for this query.
It provides methods to group the result by certain fields.

Returns:

A query group by builder to add group by statements

See Also:

• SignalEventQuery.AggregationQuery.countRows()

API:

This public API is available in Java.

orderBy

public SignalEventQuery.IOrderByQueryColumns orderBy()

Returns an object which contains the order by part for this query.
It provides methods to order the result by certain columns.

Returns:

An order by query builder to add order by statements

API:

This public API is available in Java.

where

public SignalEventQuery.IFilterQuery where()

Returns an object which contains the where part for this query.
It provides methods to filter the result by certain columns.

Returns:

An filter query builder to add where statements

API:

This public API is available in Java.

asJson

@Deprecated
public String asJson()

Deprecated.

Do not serialize and deserialize Query. There is no guarantee that the serialized form is compatible with each version of ivy.

This method allows to serialize a query as json and to deserialize the query by calling the corresponding fromJson(String) on the specific query.

This allows to store the query in a database or send it over the wire to execute it at a later time or on a remote engine.

Note, that NOT all methods supports de-/serialization proper. When using database related parameters like a User or Role the method with the username or the rolename has to be used, in order to evaluate the correct user or role on execution.

Returns:

the query as json

API:

This public API is available in Java.

toType

@Deprecated
public <T> T toType(Class<T> clazz)

Deprecated.

API:

This public API is available in Java.