UserBaseQueryImpl (Flowable Core 3.10.0)

java.lang.Object
- org.flowable.common.engine.impl.db.ListQueryParameterObject
- - org.flowable.common.engine.impl.query.AbstractQuery<T,U>
 - - org.flowable.variable.service.impl.AbstractVariableQueryImpl<T,U>
 - - com.flowable.idm.engine.impl.UserBaseQueryImpl<T,U>

All Implemented Interfaces:

Serializable, CacheAwareQuery, Query<T,U>, Command<Object>, UserBaseQuery<T,U>

Direct Known Subclasses:

PlatformUserQueryImpl
```
public abstract class UserBaseQueryImpl<T extends UserBaseQuery<T,U>,U extends User>
extends AbstractVariableQueryImpl<T,U>
implements UserBaseQuery<T,U>, CacheAwareQuery
```
Author:

Joram Barrez, Filip Hrisafov

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 boolean`	`accessbleByUserDefinitionKeyProvided`
`protected String`	`accessibleByUser`
`protected String`	`accessibleByUserDefinitionKey`
`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 List<T>`	`orQueryObjects`
`protected String`	`tenantId`

Fields inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl
queryVariableValues, variableServiceConfiguration

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
`UserBaseQueryImpl()`
`UserBaseQueryImpl(CommandContext commandContext, CoreIdmEngineConfiguration idmEngineConfiguration)`
`UserBaseQueryImpl(CommandExecutor commandExecutor, CoreIdmEngineConfiguration idmEngineConfiguration)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract T`	`createNewQuery(CommandContext commandContext, CoreIdmEngineConfiguration idmEngineConfiguration)`
`protected void`	`ensureVariablesInitialized()`
`long`	`executeCount(CommandContext commandContext)`
`protected abstract long`	`executeFindUserCount(CommandContext commandContext)`
`protected abstract List<U>`	`executeFindUserList(CommandContext commandContext)`
`List<U>`	`executeList(CommandContext commandContext)`
`String`	`getAccessibleByUser()`
`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()`
`List<T>`	`getOrQueryObjects()`
`String`	`getTenantId()`
`protected boolean`	`handleAccessibleByUser(CommandContext commandContext)` Perform the accessible by user checks and enrich the query with the required data.
`protected boolean`	`handleDynamicLookupVariable(UserBaseQueryImpl<T,U> query, String lookupInfoName)`
`protected boolean`	`handleLookupGroups(UserBaseQueryImpl<T,U> query, List<String> lookupGroups)`
`T`	`memberOfGroup(String groupId)`
`T`	`memberOfGroups(List<String> groupIds)`
`T`	`orderByUserEmail()`
`T`	`orderByUserFirstName()`
`T`	`orderByUserId()`
`T`	`orderByUserLastName()`
`T`	`tenantId(String tenantId)`
`T`	`userDisplayName(String displayName)`
`T`	`userDisplayNameLike(String displayNameLike)`
`T`	`userDisplayNameLikeIgnoreCase(String displayNameLikeIgnoreCase)`
`T`	`userEmail(String email)`
`T`	`userEmailLike(String emailLike)`
`T`	`userFirstName(String firstName)`
`T`	`userFirstNameLike(String firstNameLike)`
`T`	`userFirstNameLikeIgnoreCase(String firstNameLikeIgnoreCase)`
`T`	`userFullNameLike(String fullNameLike)`
`T`	`userFullNameLikeIgnoreCase(String fullNameLikeIgnoreCase)`
`T`	`userId(String id)`
`T`	`userIdIgnoreCase(String id)`
`T`	`userIds(List<String> ids)`
`T`	`userLastName(String lastName)`
`T`	`userLastNameLike(String lastNameLike)`
`T`	`userLastNameLikeIgnoreCase(String lastNameLikeIgnoreCase)`

Methods inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl
addVariable, getQueryVariableValues, hasLocalQueryVariableValue, hasNonLocalQueryVariableValue, hasValueComparisonQueryVariables, isBoolean, variableExists, variableExists, variableNotExists, variableNotExists, variableValueEquals, variableValueEquals, variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThan, variableValueLessThanOrEqual, variableValueLessThanOrEqual, variableValueLike, variableValueLike, variableValueLikeIgnoreCase, variableValueLikeIgnoreCase, variableValueNotEquals, variableValueNotEquals, variableValueNotEqualsIgnoreCase, variableValueNotEqualsIgnoreCase

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

accessibleByUser
```
protected String accessibleByUser
```

accessibleByUserDefinitionKey

protected String accessibleByUserDefinitionKey

accessbleByUserDefinitionKeyProvided

protected boolean accessbleByUserDefinitionKeyProvided

email
```
protected String email
```

emailLike
```
protected String emailLike
```

groupId
```
protected String groupId
```

groupIds
```
protected List<String> groupIds
```

tenantId
```
protected String tenantId
```

orQueryObjects

protected List<T extends UserBaseQuery<T,U>> orQueryObjects

Constructor Detail

UserBaseQueryImpl
```
public UserBaseQueryImpl()
```

UserBaseQueryImpl

public UserBaseQueryImpl(CommandContext commandContext,
                         CoreIdmEngineConfiguration idmEngineConfiguration)

UserBaseQueryImpl

public UserBaseQueryImpl(CommandExecutor commandExecutor,
                         CoreIdmEngineConfiguration idmEngineConfiguration)

Method Detail
- userId
```
public T userId(String id)
```
 Specified by:
 
 userId in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userIds
```
public T userIds(List<String> ids)
```
 Specified by:
 
 userIds in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userIdIgnoreCase
```
public T userIdIgnoreCase(String id)
```
 Specified by:
 
 userIdIgnoreCase in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userFirstName
```
public T userFirstName(String firstName)
```
 Specified by:
 
 userFirstName in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userFirstNameLike
```
public T userFirstNameLike(String firstNameLike)
```
 Specified by:
 
 userFirstNameLike in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userFirstNameLikeIgnoreCase
```
public T userFirstNameLikeIgnoreCase(String firstNameLikeIgnoreCase)
```
 Specified by:
 
 userFirstNameLikeIgnoreCase in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userLastName
```
public T userLastName(String lastName)
```
 Specified by:
 
 userLastName in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userLastNameLike
```
public T userLastNameLike(String lastNameLike)
```
 Specified by:
 
 userLastNameLike in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userLastNameLikeIgnoreCase
```
public T userLastNameLikeIgnoreCase(String lastNameLikeIgnoreCase)
```
 Specified by:
 
 userLastNameLikeIgnoreCase in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userFullNameLike
```
public T userFullNameLike(String fullNameLike)
```
 Specified by:
 
 userFullNameLike in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userFullNameLikeIgnoreCase
```
public T userFullNameLikeIgnoreCase(String fullNameLikeIgnoreCase)
```
 Specified by:
 
 userFullNameLikeIgnoreCase in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userDisplayName
```
public T userDisplayName(String displayName)
```
 Specified by:
 
 userDisplayName in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userDisplayNameLike
```
public T userDisplayNameLike(String displayNameLike)
```
 Specified by:
 
 userDisplayNameLike in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userDisplayNameLikeIgnoreCase
```
public T userDisplayNameLikeIgnoreCase(String displayNameLikeIgnoreCase)
```
 Specified by:
 
 userDisplayNameLikeIgnoreCase in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userEmail
```
public T userEmail(String email)
```
 Specified by:
 
 userEmail in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- userEmailLike
```
public T userEmailLike(String emailLike)
```
 Specified by:
 
 userEmailLike in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- memberOfGroup
```
public T memberOfGroup(String groupId)
```
 Specified by:
 
 memberOfGroup in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- memberOfGroups
```
public T memberOfGroups(List<String> groupIds)
```
 Specified by:
 
 memberOfGroups in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- tenantId
```
public T tenantId(String tenantId)
```
 Specified by:
 
 tenantId in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- orderByUserId
```
public T orderByUserId()
```
 Specified by:
 
 orderByUserId in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- orderByUserEmail
```
public T orderByUserEmail()
```
 Specified by:
 
 orderByUserEmail in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- orderByUserFirstName
```
public T orderByUserFirstName()
```
 Specified by:
 
 orderByUserFirstName in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- orderByUserLastName
```
public T orderByUserLastName()
```
 Specified by:
 
 orderByUserLastName in interface UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
- executeCount
```
public long executeCount(CommandContext commandContext)
```
 Specified by:
 
 executeCount in class AbstractVariableQueryImpl<T extends UserBaseQuery<T,U>,U extends User>
- executeFindUserCount
```
protected abstract long executeFindUserCount(CommandContext commandContext)
```
- executeList
```
public List executeList(CommandContext commandContext)
```
 Specified by:
 
 executeList in class AbstractVariableQueryImpl<T extends UserBaseQuery<T,U>,U extends User>
- executeFindUserList
```
protected abstract List executeFindUserList(CommandContext commandContext)
```
- ensureVariablesInitialized
```
protected void ensureVariablesInitialized()
```
 Overrides:
 
 ensureVariablesInitialized in class AbstractVariableQueryImpl<T extends UserBaseQuery<T,U>,U extends User>
- handleAccessibleByUser
```
protected boolean handleAccessibleByUser(CommandContext commandContext)
```
 Perform the accessible by user checks and enrich the query with the required data.
 
 Parameters:
 
 commandContext - the command context that can be used to fetch data
 
 Returns:
 
 true if the query can actually be executed, false otherwise (return empty result)
- handleLookupGroups
```
protected boolean handleLookupGroups(UserBaseQueryImpl<T,U> query,
 List<String> lookupGroups)
```
- handleDynamicLookupVariable
```
protected boolean handleDynamicLookupVariable(UserBaseQueryImpl<T,U> query,
 String lookupInfoName)
```
- createNewQuery
```
protected abstract T createNewQuery(CommandContext commandContext,
 CoreIdmEngineConfiguration idmEngineConfiguration)
```
- getId
```
public String getId()
```
 Specified by:
 
 getId in interface CacheAwareQuery
- 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()
```
- getFullNameLike
```
public String getFullNameLike()
```
- getFullNameLikeIgnoreCase
```
public String getFullNameLikeIgnoreCase()
```
- getDisplayName
```
public String getDisplayName()
```
- getDisplayNameLike
```
public String getDisplayNameLike()
```
- getDisplayNameLikeIgnoreCase
```
public String getDisplayNameLikeIgnoreCase()
```
- getAccessibleByUser
```
public String getAccessibleByUser()
```
- getEmail
```
public String getEmail()
```
- getEmailLike
```
public String getEmailLike()
```
- getGroupId
```
public String getGroupId()
```
- getGroupIds
```
public List<String> getGroupIds()
```
- getTenantId
```
public String getTenantId()
```
- getOrQueryObjects
```
public List<T> getOrQueryObjects()
```

Class UserBaseQueryImpl<T extends UserBaseQuery<T,U>,U extends User>

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.variable.service.impl.AbstractVariableQueryImpl

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.variable.service.impl.AbstractVariableQueryImpl

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

accessibleByUser

accessibleByUserDefinitionKey

accessbleByUserDefinitionKeyProvided

email

emailLike

groupId

groupIds

tenantId

orQueryObjects

Constructor Detail

UserBaseQueryImpl

UserBaseQueryImpl

UserBaseQueryImpl

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

executeFindUserCount

executeList

executeFindUserList

ensureVariablesInitialized

handleAccessibleByUser

handleLookupGroups

handleDynamicLookupVariable

createNewQuery

getId

getIds

getIdIgnoreCase