UserQuery (Camunda Platform Javadocs 7.15.19-ee)

All Superinterfaces:

Query<UserQuery,User>

All Known Implementing Classes:

DbUserQueryImpl, LdapUserQueryImpl, UserQueryImpl
```
public interface UserQuery
extends Query<UserQuery,User>
```
Allows programmatic querying of User

Author:

Joram Barrez

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`UserQuery`	`memberOfGroup(String groupId)` Only select `User`s that belong to the given group.
`UserQuery`	`memberOfTenant(String tenantId)` Only select `User`s that belongs to the given tenant.
`UserQuery`	`orderByUserEmail()` Order by user email (needs to be followed by `Query.asc()` or `Query.desc()`).
`UserQuery`	`orderByUserFirstName()` Order by user first name (needs to be followed by `Query.asc()` or `Query.desc()`).
`UserQuery`	`orderByUserId()` Order by user id (needs to be followed by `Query.asc()` or `Query.desc()`).
`UserQuery`	`orderByUserLastName()` Order by user last name (needs to be followed by `Query.asc()` or `Query.desc()`).
`UserQuery`	`potentialStarter(String procDefId)` Only select `User`S that are potential starter for the given process definition.
`UserQuery`	`userEmail(String email)` Only those `User`s with the given email addres.
`UserQuery`	`userEmailLike(String emailLike)` Only select `User`s where the email matches the given parameter.
`UserQuery`	`userFirstName(String firstName)` Only select `User`s with the given firstName.
`UserQuery`	`userFirstNameLike(String firstNameLike)` Only select `User`s where the first name matches the given parameter.
`UserQuery`	`userId(String id)` Only select `User`s with the given id/
`UserQuery`	`userIdIn(String... ids)` Only select `User`s with the given ids
`UserQuery`	`userLastName(String lastName)` Only select `User`s with the given lastName.
`UserQuery`	`userLastNameLike(String lastNameLike)` Only select `User`s where the last name matches the given parameter.

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

- Method Detail
  - userId
```
UserQuery userId(String id)
```
    Only select Users with the given id/
  - userIdIn
```
UserQuery userIdIn(String... ids)
```
    Only select Users with the given ids
  - userFirstName
```
UserQuery userFirstName(String firstName)
```
    Only select Users with the given firstName.
  - userFirstNameLike
```
UserQuery userFirstNameLike(String firstNameLike)
```
    Only select Users where the first name matches the given parameter. The syntax is that of SQL, eg. %activivi%.
  - userLastName
```
UserQuery userLastName(String lastName)
```
    Only select Users with the given lastName.
  - userLastNameLike
```
UserQuery userLastNameLike(String lastNameLike)
```
    Only select Users where the last name matches the given parameter. The syntax is that of SQL, eg. %activivi%.
  - userEmail
```
UserQuery userEmail(String email)
```
    Only those Users with the given email addres.
  - userEmailLike
```
UserQuery userEmailLike(String emailLike)
```
    Only select Users where the email matches the given parameter. The syntax is that of SQL, eg. %activivi%.
  - memberOfGroup
```
UserQuery memberOfGroup(String groupId)
```
    Only select Users that belong to the given group.
  - potentialStarter
```
UserQuery potentialStarter(String procDefId)
```
    Only select UserS that are potential starter for the given process definition.
  - memberOfTenant
```
UserQuery memberOfTenant(String tenantId)
```
    Only select Users that belongs to the given tenant.
  - orderByUserId
```
UserQuery orderByUserId()
```
    Order by user id (needs to be followed by Query.asc() or Query.desc()).
  - orderByUserFirstName
```
UserQuery orderByUserFirstName()
```
    Order by user first name (needs to be followed by Query.asc() or Query.desc()).
  - orderByUserLastName
```
UserQuery orderByUserLastName()
```
    Order by user last name (needs to be followed by Query.asc() or Query.desc()).
  - orderByUserEmail
```
UserQuery orderByUserEmail()
```
    Order by user email (needs to be followed by Query.asc() or Query.desc()).

Interface UserQuery

Method Summary

Methods inherited from interface org.camunda.bpm.engine.query.Query

Method Detail

userId

userIdIn

userFirstName

userFirstNameLike

userLastName

userLastNameLike

userEmail

userEmailLike

memberOfGroup

potentialStarter

memberOfTenant

orderByUserId

orderByUserFirstName

orderByUserLastName

orderByUserEmail