UserQueryImpl (Flowable 6.7.0 API)

java.lang.Object
- org.flowable.common.engine.impl.db.ListQueryParameterObject
- - org.flowable.common.engine.impl.query.AbstractQuery<UserQuery,User>
  - - org.flowable.idm.engine.impl.UserQueryImpl

All Implemented Interfaces:

Serializable, CacheAwareQuery<UserEntity>, Query<UserQuery,User>, Command<Object>, UserBaseQuery<UserQuery,User>, UserQuery

Direct Known Subclasses:

KeycloakUserQueryImpl, LDAPUserQueryImpl
```
public class UserQueryImpl
extends AbstractQuery<UserQuery,User>
implements UserQuery, CacheAwareQuery<UserEntity>
```
Author:

Joram Barrez

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
  ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType
- Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
  Query.NullHandlingOnOrder

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`displayName`
`protected String`	`displayNameLike`
`protected String`	`displayNameLikeIgnoreCase`
`protected String`	`email`
`protected String`	`emailLike`
`protected String`	`firstName`
`protected String`	`firstNameLike`
`protected String`	`firstNameLikeIgnoreCase`
`protected String`	`fullNameLike`
`protected String`	`fullNameLikeIgnoreCase`
`protected String`	`groupId`
`protected List<String>`	`groupIds`
`protected String`	`id`
`protected String`	`idIgnoreCase`
`protected List<String>`	`ids`
`protected String`	`lastName`
`protected String`	`lastNameLike`
`protected String`	`lastNameLikeIgnoreCase`
`protected String`	`tenantId`

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery
commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors
Constructor and Description

UserQueryImpl()

UserQueryImpl(CommandContext commandContext)

UserQueryImpl(CommandExecutor commandExecutor)

Constructors
Constructor and Description
`UserQueryImpl()`
`UserQueryImpl(CommandContext commandContext)`
`UserQueryImpl(CommandExecutor commandExecutor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`executeCount(CommandContext commandContext)`
`List<User>`	`executeList(CommandContext commandContext)` Executes the actual query to retrieve the list of results.
`String`	`getDisplayName()`
`String`	`getDisplayNameLike()`
`String`	`getDisplayNameLikeIgnoreCase()`
`String`	`getEmail()`
`String`	`getEmailLike()`
`String`	`getFirstName()`
`String`	`getFirstNameLike()`
`String`	`getFirstNameLikeIgnoreCase()`
`String`	`getFullNameLike()`
`String`	`getFullNameLikeIgnoreCase()`
`String`	`getGroupId()`
`List<String>`	`getGroupIds()`
`String`	`getId()`
`String`	`getIdIgnoreCase()`
`List<String>`	`getIds()`
`String`	`getLastName()`
`String`	`getLastNameLike()`
`String`	`getLastNameLikeIgnoreCase()`
`String`	`getTenantId()`
`UserQuery`	`memberOfGroup(String groupId)` Only select `User`s that belong to the given group.
`UserQuery`	`memberOfGroups(List<String> groupIds)` Only select `User`s that belong to the given groups.
`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`	`tenantId(String tenantId)` Only select `User`s that belong to the given tenant.
`UserQuery`	`userDisplayName(String displayName)` Only select `User`s with the given displayName.
`UserQuery`	`userDisplayNameLike(String displayNameLike)` Only select `User`s where the display name matches the given parameter.
`UserQuery`	`userDisplayNameLikeIgnoreCase(String displayNameLikeIgnoreCase)` Only select `User`s where the display name matches the given parameter (ignoring case).
`UserQuery`	`userEmail(String email)` Only those `User`s with the given email address.
`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`	`userFirstNameLikeIgnoreCase(String firstNameLikeIgnoreCase)` Only select `User`s where the first name matches the given parameter (ignoring case).
`UserQuery`	`userFullNameLike(String fullNameLike)` Only select `User`s where the full name matches the given parameters.
`UserQuery`	`userFullNameLikeIgnoreCase(String fullNameLikeIgnoreCase)` Only select `User`s where the full name matches the given parameters (ignoring case).
`UserQuery`	`userId(String id)` Only select `User`s with the given id/
`UserQuery`	`userIdIgnoreCase(String id)` Only select `User`s with the given id (ignoring case) /
`UserQuery`	`userIds(List<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.
`UserQuery`	`userLastNameLikeIgnoreCase(String lastNameLikeIgnoreCase)` Only select `User`s where the last name matches the given parameter (ignoring case).

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery
asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Methods inherited from interface org.flowable.common.engine.api.query.CacheAwareQuery
enhanceCachedValue

- Field Detail
  - id
```
protected String id
```
  - ids
```
protected List<String> ids
```
  - idIgnoreCase
```
protected String idIgnoreCase
```
  - firstName
```
protected String firstName
```
  - firstNameLike
```
protected String firstNameLike
```
  - firstNameLikeIgnoreCase
```
protected String firstNameLikeIgnoreCase
```
  - lastName
```
protected String lastName
```
  - lastNameLike
```
protected String lastNameLike
```
  - lastNameLikeIgnoreCase
```
protected String lastNameLikeIgnoreCase
```
  - fullNameLike
```
protected String fullNameLike
```
  - fullNameLikeIgnoreCase
```
protected String fullNameLikeIgnoreCase
```
  - displayName
```
protected String displayName
```
  - displayNameLike
```
protected String displayNameLike
```
  - displayNameLikeIgnoreCase
```
protected String displayNameLikeIgnoreCase
```
  - email
```
protected String email
```
  - emailLike
```
protected String emailLike
```
  - groupId
```
protected String groupId
```
  - groupIds
```
protected List<String> groupIds
```
  - tenantId
```
protected String tenantId
```
- Constructor Detail
  - UserQueryImpl
```
public UserQueryImpl()
```
  - UserQueryImpl
```
public UserQueryImpl(CommandContext commandContext)
```
  - UserQueryImpl
```
public UserQueryImpl(CommandExecutor commandExecutor)
```
- Method Detail
  - userId
```
public UserQuery userId(String id)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users with the given id/
    
    Specified by:
    
    userId in interface UserBaseQuery<UserQuery,User>
  - userIds
```
public UserQuery userIds(List<String> ids)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users with the given ids/
    
    Specified by:
    
    userIds in interface UserBaseQuery<UserQuery,User>
  - userIdIgnoreCase
```
public UserQuery userIdIgnoreCase(String id)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users with the given id (ignoring case) /
    
    Specified by:
    
    userIdIgnoreCase in interface UserBaseQuery<UserQuery,User>
  - userFirstName
```
public UserQuery userFirstName(String firstName)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users with the given firstName.
    
    Specified by:
    
    userFirstName in interface UserBaseQuery<UserQuery,User>
  - userFirstNameLike
```
public UserQuery userFirstNameLike(String firstNameLike)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the first name matches the given parameter. The syntax is that of SQL, eg. %name%.
    
    Specified by:
    
    userFirstNameLike in interface UserBaseQuery<UserQuery,User>
  - userFirstNameLikeIgnoreCase
```
public UserQuery userFirstNameLikeIgnoreCase(String firstNameLikeIgnoreCase)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the first name matches the given parameter (ignoring case). The syntax is that of SQL, eg. %name%.
    
    Specified by:
    
    userFirstNameLikeIgnoreCase in interface UserBaseQuery<UserQuery,User>
  - userLastName
```
public UserQuery userLastName(String lastName)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users with the given lastName.
    
    Specified by:
    
    userLastName in interface UserBaseQuery<UserQuery,User>
  - userLastNameLike
```
public UserQuery userLastNameLike(String lastNameLike)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the last name matches the given parameter. The syntax is that of SQL, eg. %name%.
    
    Specified by:
    
    userLastNameLike in interface UserBaseQuery<UserQuery,User>
  - userLastNameLikeIgnoreCase
```
public UserQuery userLastNameLikeIgnoreCase(String lastNameLikeIgnoreCase)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the last name matches the given parameter (ignoring case). The syntax is that of SQL, eg. %name%.
    
    Specified by:
    
    userLastNameLikeIgnoreCase in interface UserBaseQuery<UserQuery,User>
  - userFullNameLike
```
public UserQuery userFullNameLike(String fullNameLike)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the full name matches the given parameters. Both the first name and last name will be tried, ie in semi-sql: where firstName like xxx or lastname like xxx
    
    Specified by:
    
    userFullNameLike in interface UserBaseQuery<UserQuery,User>
  - userFullNameLikeIgnoreCase
```
public UserQuery userFullNameLikeIgnoreCase(String fullNameLikeIgnoreCase)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the full name matches the given parameters (ignoring case). Both the first name and last name will be tried, ie in semi-sql: where firstName like xxx or lastname like xxx
    
    Specified by:
    
    userFullNameLikeIgnoreCase in interface UserBaseQuery<UserQuery,User>
  - userDisplayName
```
public UserQuery userDisplayName(String displayName)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users with the given displayName.
    
    Specified by:
    
    userDisplayName in interface UserBaseQuery<UserQuery,User>
  - userDisplayNameLike
```
public UserQuery userDisplayNameLike(String displayNameLike)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the display name matches the given parameter. The syntax is that of SQL, eg. %name%.
    
    Specified by:
    
    userDisplayNameLike in interface UserBaseQuery<UserQuery,User>
  - userDisplayNameLikeIgnoreCase
```
public UserQuery userDisplayNameLikeIgnoreCase(String displayNameLikeIgnoreCase)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the display name matches the given parameter (ignoring case). The syntax is that of SQL, eg. %name%.
    
    Specified by:
    
    userDisplayNameLikeIgnoreCase in interface UserBaseQuery<UserQuery,User>
  - userEmail
```
public UserQuery userEmail(String email)
```
    Description copied from interface: UserBaseQuery
    
    Only those Users with the given email address.
    
    Specified by:
    
    userEmail in interface UserBaseQuery<UserQuery,User>
  - userEmailLike
```
public UserQuery userEmailLike(String emailLike)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users where the email matches the given parameter. The syntax is that of SQL, eg. %test%.
    
    Specified by:
    
    userEmailLike in interface UserBaseQuery<UserQuery,User>
  - memberOfGroup
```
public UserQuery memberOfGroup(String groupId)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users that belong to the given group.
    
    Specified by:
    
    memberOfGroup in interface UserBaseQuery<UserQuery,User>
  - memberOfGroups
```
public UserQuery memberOfGroups(List<String> groupIds)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users that belong to the given groups.
    
    Specified by:
    
    memberOfGroups in interface UserBaseQuery<UserQuery,User>
  - tenantId
```
public UserQuery tenantId(String tenantId)
```
    Description copied from interface: UserBaseQuery
    
    Only select Users that belong to the given tenant.
    
    Specified by:
    
    tenantId in interface UserBaseQuery<UserQuery,User>
  - orderByUserId
```
public UserQuery orderByUserId()
```
    Description copied from interface: UserBaseQuery
    
    Order by user id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByUserId in interface UserBaseQuery<UserQuery,User>
  - orderByUserEmail
```
public UserQuery orderByUserEmail()
```
    Description copied from interface: UserBaseQuery
    
    Order by user email (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByUserEmail in interface UserBaseQuery<UserQuery,User>
  - orderByUserFirstName
```
public UserQuery orderByUserFirstName()
```
    Description copied from interface: UserBaseQuery
    
    Order by user first name (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByUserFirstName in interface UserBaseQuery<UserQuery,User>
  - orderByUserLastName
```
public UserQuery orderByUserLastName()
```
    Description copied from interface: UserBaseQuery
    
    Order by user last name (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByUserLastName in interface UserBaseQuery<UserQuery,User>
  - executeCount
```
public long executeCount(CommandContext commandContext)
```
    Specified by:
    
    executeCount in class AbstractQuery<UserQuery,User>
  - executeList
```
public List<User> executeList(CommandContext commandContext)
```
    Description copied from class: AbstractQuery
    
    Executes the actual query to retrieve the list of results.
    
    Specified by:
    
    executeList in class AbstractQuery<UserQuery,User>
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface CacheAwareQuery<UserEntity>
  - getIds
```
public List<String> getIds()
```
  - getIdIgnoreCase
```
public String getIdIgnoreCase()
```
  - getFirstName
```
public String getFirstName()
```
  - getFirstNameLike
```
public String getFirstNameLike()
```
  - getFirstNameLikeIgnoreCase
```
public String getFirstNameLikeIgnoreCase()
```
  - getLastName
```
public String getLastName()
```
  - getLastNameLike
```
public String getLastNameLike()
```
  - getLastNameLikeIgnoreCase
```
public String getLastNameLikeIgnoreCase()
```
  - getEmail
```
public String getEmail()
```
  - getEmailLike
```
public String getEmailLike()
```
  - getGroupId
```
public String getGroupId()
```
  - getGroupIds
```
public List<String> getGroupIds()
```
  - getFullNameLike
```
public String getFullNameLike()
```
  - getFullNameLikeIgnoreCase
```
public String getFullNameLikeIgnoreCase()
```
  - getDisplayName
```
public String getDisplayName()
```
  - getDisplayNameLike
```
public String getDisplayNameLike()
```
  - getDisplayNameLikeIgnoreCase
```
public String getDisplayNameLikeIgnoreCase()
```
  - getTenantId
```
public String getTenantId()
```

Class UserQueryImpl

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Field Summary

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Constructor Summary

Method Summary

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.flowable.common.engine.api.query.Query

Methods inherited from interface org.flowable.common.engine.api.query.CacheAwareQuery

Field Detail

id

ids

idIgnoreCase

firstName

firstNameLike

firstNameLikeIgnoreCase

lastName

lastNameLike

lastNameLikeIgnoreCase

fullNameLike

fullNameLikeIgnoreCase

displayName

displayNameLike

displayNameLikeIgnoreCase

email

emailLike

groupId

groupIds

tenantId

Constructor Detail

UserQueryImpl

UserQueryImpl

UserQueryImpl

Method Detail

userId

userIds

userIdIgnoreCase

userFirstName

userFirstNameLike

userFirstNameLikeIgnoreCase

userLastName

userLastNameLike

userLastNameLikeIgnoreCase

userFullNameLike

userFullNameLikeIgnoreCase

userDisplayName

userDisplayNameLike

userDisplayNameLikeIgnoreCase

userEmail

userEmailLike

memberOfGroup

memberOfGroups

tenantId

orderByUserId

orderByUserEmail

orderByUserFirstName

orderByUserLastName

executeCount

executeList

getId

getIds

getIdIgnoreCase

getFirstName

getFirstNameLike

getFirstNameLikeIgnoreCase

getLastName

getLastNameLike

getLastNameLikeIgnoreCase

getEmail

getEmailLike

getGroupId

getGroupIds

getFullNameLike

getFullNameLikeIgnoreCase

getDisplayName