GroupQuery (Camunda Platform Javadocs 7.17.0-SNAPSHOT)

All Superinterfaces:

Query<GroupQuery,Group>

All Known Implementing Classes:

DbGroupQueryImpl, GroupQueryImpl, LdapGroupQuery
```
public interface GroupQuery
extends Query<GroupQuery,Group>
```
Allows to programmatically query for Groups.

Author:

Joram Barrez

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`GroupQuery`	`groupId(String groupId)`	Only select `Group`s with the given id.
`GroupQuery`	`groupIdIn(String... ids)`	Only select `Group`s with the given ids
`GroupQuery`	`groupMember(String groupMemberUserId)`	Only selects `Group`s where the given user is a member of.
`GroupQuery`	`groupName(String groupName)`	Only select `Group`s with the given name.
`GroupQuery`	`groupNameLike(String groupNameLike)`	Only select `Group`s where the name matches the given parameter.
`GroupQuery`	`groupType(String groupType)`	Only select `Group`s which have the given type.
`GroupQuery`	`memberOfTenant(String tenantId)`	Only select `Group`s that belongs to the given tenant.
`GroupQuery`	`orderByGroupId()`	Order by group id (needs to be followed by `Query.asc()` or `Query.desc()`).
`GroupQuery`	`orderByGroupName()`	Order by group name (needs to be followed by `Query.asc()` or `Query.desc()`).
`GroupQuery`	`orderByGroupType()`	Order by group type (needs to be followed by `Query.asc()` or `Query.desc()`).
`GroupQuery`	`potentialStarter(String procDefId)`	Only select `Group`S that are potential starter for the given process definition.

Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList

- Method Detail
  - groupId
```
GroupQuery groupId(String groupId)
```
    Only select Groups with the given id.
  - groupIdIn
```
GroupQuery groupIdIn(String... ids)
```
    Only select Groups with the given ids
  - groupName
```
GroupQuery groupName(String groupName)
```
    Only select Groups with the given name.
  - groupNameLike
```
GroupQuery groupNameLike(String groupNameLike)
```
    Only select Groups where the name matches the given parameter. The syntax to use is that of SQL, eg. %activiti%.
  - groupType
```
GroupQuery groupType(String groupType)
```
    Only select Groups which have the given type.
  - groupMember
```
GroupQuery groupMember(String groupMemberUserId)
```
    Only selects Groups where the given user is a member of.
  - potentialStarter
```
GroupQuery potentialStarter(String procDefId)
```
    Only select GroupS that are potential starter for the given process definition.
  - memberOfTenant
```
GroupQuery memberOfTenant(String tenantId)
```
    Only select Groups that belongs to the given tenant.
  - orderByGroupId
```
GroupQuery orderByGroupId()
```
    Order by group id (needs to be followed by Query.asc() or Query.desc()).
  - orderByGroupName
```
GroupQuery orderByGroupName()
```
    Order by group name (needs to be followed by Query.asc() or Query.desc()).
  - orderByGroupType
```
GroupQuery orderByGroupType()
```
    Order by group type (needs to be followed by Query.asc() or Query.desc()).