Package ch.ivyteam.ivy.workflow.query

Class CaseQuery.GroupByQuery

java.lang.Object

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

ch.ivyteam.ivy.workflow.query.CaseQuery

ch.ivyteam.ivy.workflow.query.CaseQuery.GroupByQuery

All Implemented Interfaces:

CaseQuery.IGroupByQueryColumns

Enclosing class:

CaseQuery

public class CaseQuery.GroupByQuery
extends CaseQuery
implements CaseQuery.IGroupByQueryColumns

Provides methods to group the result by certain fields.

Example:

CaseQuery.businessCases().groupBy().ownerRoleId().ownerName().aggregate().countRows();

Corresponds to SQL:

SELECT OwnerRoleId, OwnerUserId, Count(*) AS Count FROM IWA_Case GROUP BY OwnerRoleId, OwnerUserId

API:

This is a public API.

Nested Class Summary

Nested classes/interfaces inherited from class ch.ivyteam.ivy.workflow.query.CaseQuery

CaseQuery.AggregationQuery, CaseQuery.EnumValueOrderByColumnQuery<T extends ch.ivyteam.ivy.persistence.IPersistentEnumeration>, CaseQuery.FilterLink, CaseQuery.FilterQuery, CaseQuery.GroupByQuery, CaseQuery.IAggregationQuery, CaseQuery.IBoolFilterQuery, CaseQuery.ICaseBusinessStateFilterQuery, CaseQuery.ICaseStateFilterQuery, CaseQuery.IClobColumnFilterQuery, CaseQuery.IColumnFilterQuery, CaseQuery.ICustomFieldAggregationQuery, CaseQuery.ICustomFieldFilterQuery, CaseQuery.ICustomFieldGroupBy, CaseQuery.ICustomFieldOrderBy, CaseQuery.IDateColumnFilterQuery, CaseQuery.IFilterableColumns, CaseQuery.IFilterLink, CaseQuery.IFilterQuery, CaseQuery.IGroupByQueryColumns, CaseQuery.IIntegerColumnFilterQuery, CaseQuery.INumberColumnFilterQuery, CaseQuery.IOrderByQueryColumns, CaseQuery.IPatternColumnFilterQuery, CaseQuery.IStringColumnFilterQuery, CaseQuery.IUUIDColumnFilterQuery, CaseQuery.IWorkflowPriorityFilterQuery, CaseQuery.LongValueOrderByColumnQuery, CaseQuery.OrderByColumnQuery, CaseQuery.OrderByQuery, CaseQuery.StringValueOrderByColumnQuery

Method Summary

Modifier and Type	Method	Description
CaseQuery.GroupByQuery	activatorId()	Groups the result of the query by the field ActivatorId.
CaseQuery.GroupByQuery	applicationId()	Groups the result of the query by the field ApplicationId.
CaseQuery.GroupByQuery	businessCalendar()	Groups the result of the query by the field BusinessCalendar.
CaseQuery.GroupByQuery	businessCalendarId()	Deprecated.
CaseQuery.GroupByQuery	businessCaseId()	Groups the result of the query by the field BusinessCaseId.
CaseQuery.GroupByQuery	businessRuntime()	Groups the result of the query by the field BusinessRuntime.
CaseQuery.GroupByQuery	businessState()	Groups the result of the query by the field BusinessState.
CaseQuery.GroupByQuery	caseId()	Groups the result of the query by the field CaseId.
CaseQuery.GroupByQuery	category()	Groups the result of the query by the field Category.
CaseQuery.GroupByQuery	creatorId()	Groups the result of the query by the field CreatorId.
CaseQuery.GroupByQuery	creatorTaskId()	Groups the result of the query by the field CreatorTaskId.
CaseQuery.GroupByQuery	creatorUserDisplayName()	Groups the result of the query by the field CreatorUserDisplayName.
CaseQuery.GroupByQuery	creatorUserName()	Groups the result of the query by the field CreatorUserName.
CaseQuery.ICustomFieldGroupBy	customField()	Groups the result of the query by a custom field specified during further composition.
CaseQuery.GroupByQuery	description()	Groups the result of the query by the field Description.
CaseQuery.GroupByQuery	displayDescriptionTemplate()	Deprecated, for removal: This API element is subject to removal in a future version.
CaseQuery.GroupByQuery	displayNameTemplate()	Deprecated, for removal: This API element is subject to removal in a future version.
CaseQuery.GroupByQuery	endTimestamp()	Groups the result of the query by the field EndTimestamp.
CaseQuery.GroupByQuery	languageId()	Groups the result of the query by the field LanguageId.
CaseQuery.GroupByQuery	name()	Groups the result of the query by the field Name.
CaseQuery.GroupByQuery	ownerDisplayName()	Groups the result of the query by the field OwnerDisplayName.
CaseQuery.GroupByQuery	ownerId()	Groups the result of the query by the field OwnerId.
CaseQuery.GroupByQuery	ownerName()	Groups the result of the query by the field OwnerName.
CaseQuery.GroupByQuery	priority()	Groups the result of the query by the field Priority.
CaseQuery.GroupByQuery	processModelId()	Groups the result of the query by the field ProcessModelId.
CaseQuery.GroupByQuery	securitySystemId()	Groups the result of the query by the field SecuritySystemId.
CaseQuery.GroupByQuery	stage()	Groups the result of the query by the field Stage.
CaseQuery.GroupByQuery	startTimestamp()	Groups the result of the query by the field StartTimestamp.
CaseQuery.GroupByQuery	state()	Groups the result of the query by the field State.
CaseQuery.GroupByQuery	taskStartId()	Groups the result of the query by the field TaskStartId.
CaseQuery.GroupByQuery	workingTime()	Groups the result of the query by the field WorkingTime.

Methods inherited from class ch.ivyteam.ivy.workflow.query.CaseQuery

aggregate, asJson, businessCases, create, executor, fromJson, groupBy, orderBy, subCases, toType, where

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

equals, hashCode

Method Details

caseId

public CaseQuery.GroupByQuery caseId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field CaseId.

SQL part: GROUP BY CaseId

Specified by:

caseId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessCaseId

public CaseQuery.GroupByQuery businessCaseId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field BusinessCaseId.

SQL part: GROUP BY BusinessCaseId

Specified by:

businessCaseId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

securitySystemId

public CaseQuery.GroupByQuery securitySystemId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field SecuritySystemId.

SQL part: GROUP BY SecuritySystemId

Specified by:

securitySystemId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

applicationId

public CaseQuery.GroupByQuery applicationId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field ApplicationId.

SQL part: GROUP BY ApplicationId

Specified by:

applicationId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

processModelId

public CaseQuery.GroupByQuery processModelId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field ProcessModelId.

SQL part: GROUP BY ProcessModelId

Specified by:

processModelId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

taskStartId

public CaseQuery.GroupByQuery taskStartId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field TaskStartId.

SQL part: GROUP BY TaskStartId

Specified by:

taskStartId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

activatorId

public CaseQuery.GroupByQuery activatorId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field ActivatorId.

SQL part: GROUP BY ActivatorId

Specified by:

activatorId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorId

public CaseQuery.GroupByQuery creatorId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field CreatorId.

SQL part: GROUP BY CreatorId

Specified by:

creatorId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorUserName

public CaseQuery.GroupByQuery creatorUserName()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field CreatorUserName.

SQL part: GROUP BY CreatorUserName

This is a virtual column. It contains the same value as the column Name of the referenced Creator.

Specified by:

creatorUserName in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorUserDisplayName

public CaseQuery.GroupByQuery creatorUserDisplayName()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field CreatorUserDisplayName.

SQL part: GROUP BY CreatorUserDisplayName

This is a virtual column. It contains the same value as the column DisplayName of the referenced Creator.

Specified by:

creatorUserDisplayName in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorTaskId

public CaseQuery.GroupByQuery creatorTaskId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field CreatorTaskId.

SQL part: GROUP BY CreatorTaskId

Specified by:

creatorTaskId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

name

public CaseQuery.GroupByQuery name()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field Name.

SQL part: GROUP BY Name

This is a virtual column. It contains the same value as the column Name of the referenced CaseLocalized.

Specified by:

name in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

description

public CaseQuery.GroupByQuery description()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field Description.

SQL part: GROUP BY Description

This is a virtual column. It contains the same value as the column Description of the referenced CaseLocalized.

Specified by:

description in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

startTimestamp

public CaseQuery.GroupByQuery startTimestamp()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field StartTimestamp.

SQL part: GROUP BY StartTimestamp

Specified by:

startTimestamp in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

endTimestamp

public CaseQuery.GroupByQuery endTimestamp()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field EndTimestamp.

SQL part: GROUP BY EndTimestamp

Specified by:

endTimestamp in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessCalendar

public CaseQuery.GroupByQuery businessCalendar()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field BusinessCalendar.

SQL part: GROUP BY BusinessCalendar

Specified by:

businessCalendar in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

workingTime

public CaseQuery.GroupByQuery workingTime()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field WorkingTime.

SQL part: GROUP BY WorkingTime

Specified by:

workingTime in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessRuntime

public CaseQuery.GroupByQuery businessRuntime()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field BusinessRuntime.

SQL part: GROUP BY BusinessRuntime

Specified by:

businessRuntime in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

state

public CaseQuery.GroupByQuery state()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field State.

SQL part: GROUP BY State

Specified by:

state in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessState

public CaseQuery.GroupByQuery businessState()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field BusinessState.

SQL part: GROUP BY BusinessState

Specified by:

businessState in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

priority

public CaseQuery.GroupByQuery priority()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field Priority.

SQL part: GROUP BY Priority

Specified by:

priority in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

stage

public CaseQuery.GroupByQuery stage()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field Stage.

SQL part: GROUP BY Stage

Specified by:

stage in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

ownerId

public CaseQuery.GroupByQuery ownerId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field OwnerId.

SQL part: GROUP BY OwnerId

Specified by:

ownerId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

ownerName

public CaseQuery.GroupByQuery ownerName()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field OwnerName.

SQL part: GROUP BY OwnerName

This is a virtual column. It contains the same value as the column MemberName of the referenced Owner.

Specified by:

ownerName in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

ownerDisplayName

public CaseQuery.GroupByQuery ownerDisplayName()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field OwnerDisplayName.

SQL part: GROUP BY OwnerDisplayName

This is a virtual column. It contains the same value as the column DisplayName of the referenced Owner.

Specified by:

ownerDisplayName in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

category

public CaseQuery.GroupByQuery category()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field Category.

SQL part: GROUP BY Category

Specified by:

category in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

languageId

public CaseQuery.GroupByQuery languageId()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by the field LanguageId.

SQL part: GROUP BY LanguageId

This is a virtual column. It contains the same value as the column LanguageId of the referenced CaseLocalized.

Specified by:

languageId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

customField

public CaseQuery.ICustomFieldGroupBy customField()

Description copied from interface: CaseQuery.IGroupByQueryColumns

Groups the result of the query by a custom field specified during further composition.

Specified by:

customField in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessCalendarId

@Deprecated
public CaseQuery.GroupByQuery businessCalendarId()

Deprecated.

Description copied from interface: CaseQuery.IGroupByQueryColumns

This method is deprecated. Instead of grouping the query by the field BusinessCalendarId it groups by the field BusinessCalendar.

SQL part: GROUP BY BusinessCalendar

Specified by:

businessCalendarId in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

displayNameTemplate

@Deprecated(since="9.4",
            forRemoval=true)
public CaseQuery.GroupByQuery displayNameTemplate()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: CaseQuery.IGroupByQueryColumns

Does not add any group by because column DisplayNameTemplate was removed without any replacement.

Specified by:

displayNameTemplate in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.

displayDescriptionTemplate

@Deprecated(since="9.4",
            forRemoval=true)
public CaseQuery.GroupByQuery displayDescriptionTemplate()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: CaseQuery.IGroupByQueryColumns

Does not add any filter because column DisplayDescriptionTemplate was removed without any replacement.

Specified by:

displayDescriptionTemplate in interface CaseQuery.IGroupByQueryColumns

Returns:

query for further composition

API:

This public API is available in Java.