Package com.flowable.idm.engine.impl

Class PlatformUserQueryImpl

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<PlatformUserQuery,PlatformUser>

com.flowable.idm.engine.impl.PlatformUserQueryImpl

All Implemented Interfaces:

PlatformUserQuery, Serializable, CacheAwareQuery<PlatformUser>, Query<PlatformUserQuery,PlatformUser>, Command<Object>, UserBaseQuery<PlatformUserQuery,PlatformUser>

public class PlatformUserQueryImpl
extends UserBaseQueryImpl<PlatformUserQuery,PlatformUser>
implements PlatformUserQuery

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	Description
protected Date	createdAfter
protected Date	createdBefore
protected String	memberOfGroupKey
protected Collection<String>	memberOfGroupKeys
protected Collection<String>	memberOfGroupKeysForOr
protected List<String>	notInIds
protected Collection<String>	userIdsForOr
protected boolean	withoutTenantId

Fields inherited from class com.flowable.idm.engine.impl.UserBaseQueryImpl

accessbleByUserDefinitionKeyProvided, accessibleByUser, accessibleByUserDefinitionKey, displayName, displayNameLike, displayNameLikeIgnoreCase, email, emailLike, firstName, firstNameLike, firstNameLikeIgnoreCase, fullNameLike, fullNameLikeIgnoreCase, groupId, groupIds, id, idIgnoreCase, ids, lastName, lastNameLike, lastNameLikeIgnoreCase, orQueryObjects, tenantId

Fields inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl

queryVariableValues, variableValueProvider

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

Method Summary

Modifier and Type	Method	Description
PlatformUserQuery	accessibleByUser(String userId)	Query all users that are accessible by the user with the provided userId.
PlatformUserQuery	accessibleByUserWithUserDefinitionKey(String userId, String userDefinitionKey)	Query all users that are accessible by the user with the provided userId and userDefinitionKey.
PlatformUserQuery	active()
PlatformUserQuery	createAfter(Date createdAfter)
PlatformUserQuery	createdBefore(Date createdBefore)
protected PlatformUserQueryImpl	createNewQuery(CommandContext commandContext, CoreIdmEngineConfiguration idmEngineConfiguration)
protected long	executeFindUserCount(CommandContext commandContext)
protected List<PlatformUser>	executeFindUserList(CommandContext commandContext)
List<String>	getNotInIds()
PlatformUserQuery	includeIdentityInfo()	Deprecated.
PlatformUserQuery	infoEquals(String name, Object value)	Checks for a user with the given info name and value.
PlatformUserQuery	infoEqualsIgnoreCase(String name, String value)	Checks for a user with the given info name and value ignoring the case of the value.
PlatformUserQuery	infoValueLike(String name, String infoValueLike)	Checks for a user with the given info name and value like.
PlatformUserQuery	infoValueLikeIgnoreCase(String name, String infoValueLike)	Checks for a user with the given info name and value like ignoring the case of the value.
boolean	isWithoutTenantId()
PlatformUserQuery	memberOfGroupKey(String groupKey)	Only select PlatformUsers that belong to the group with the given key.
PlatformUserQuery	memberOfGroupKeys(Collection<String> groupKeys)	Only select PlatformUsers that belong to the groups with the given keys.
PlatformUserQuery	presence(String presence)	Query for users with the given presence status.
PlatformUserQuery	state(String state)
PlatformUserQuery	subState(String subState)
PlatformUserQuery	subType(String subType)
PlatformUserQuery	type(String type)	Query for users of the given type
PlatformUserQuery	userDefinitionKey(String userDefinitionKey)
PlatformUserQuery	userIdsNotIn(List<String> ids)
PlatformUserQuery	userIdsOrMemberOfGroupKeys(Collection<String> userIds, Collection<String> groupKeys)	Only select PlatformUsers with the given user ids or that belong to the groups with the given keys.
PlatformUserQuery	withoutTenantId()	Query only users belonging to no tenant.

Methods inherited from class com.flowable.idm.engine.impl.UserBaseQueryImpl

ensureVariablesInitialized, executeCount, executeList, getAccessibleByUser, getDisplayName, getDisplayNameLike, getDisplayNameLikeIgnoreCase, getEmail, getEmailLike, getFirstName, getFirstNameLike, getFirstNameLikeIgnoreCase, getFullNameLike, getFullNameLikeIgnoreCase, getGroupId, getGroupIds, getId, getIdIgnoreCase, getIds, getLastName, getLastNameLike, getLastNameLikeIgnoreCase, getOrQueryObjects, getTenantId, handleAccessibleByUser, handleDynamicLookupVariable, handleLookupGroups, memberOfGroup, memberOfGroups, orderByUserEmail, orderByUserFirstName, orderByUserId, orderByUserLastName, tenantId, userDisplayName, userDisplayNameLike, userDisplayNameLikeIgnoreCase, userEmail, userEmailLike, userFirstName, userFirstNameLike, userFirstNameLikeIgnoreCase, userFullNameLike, userFullNameLikeIgnoreCase, userId, userIdIgnoreCase, userIds, userLastName, userLastNameLike, userLastNameLikeIgnoreCase

Methods inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl

addVariable, addVariable, getQueryVariableValues, hasLocalQueryVariableValue, hasNonLocalQueryVariableValue, hasValueComparisonQueryVariables, isBoolean, scopedVariableExists, scopedVariableNotExists, scopedVariableValueEquals, scopedVariableValueEquals, scopedVariableValueEqualsIgnoreCase, scopedVariableValueGreaterThan, scopedVariableValueGreaterThanOrEqual, scopedVariableValueLessThan, scopedVariableValueLessThanOrEqual, scopedVariableValueLike, scopedVariableValueLikeIgnoreCase, scopedVariableValueNotEquals, scopedVariableValueNotEqualsIgnoreCase, 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.CacheAwareQuery

enhanceCachedValue

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.idm.api.UserBaseQuery

memberOfGroup, memberOfGroups, orderByUserEmail, orderByUserFirstName, orderByUserId, orderByUserLastName, tenantId, userDisplayName, userDisplayNameLike, userDisplayNameLikeIgnoreCase, userEmail, userEmailLike, userFirstName, userFirstNameLike, userFirstNameLikeIgnoreCase, userFullNameLike, userFullNameLikeIgnoreCase, userId, userIdIgnoreCase, userIds, userLastName, userLastNameLike, userLastNameLikeIgnoreCase

Field Details

notInIds

protected List<String> notInIds

createdBefore

protected Date createdBefore

createdAfter

protected Date createdAfter

withoutTenantId

protected boolean withoutTenantId

memberOfGroupKey

protected String memberOfGroupKey

memberOfGroupKeys

protected Collection<String> memberOfGroupKeys

userIdsForOr

protected Collection<String> userIdsForOr

memberOfGroupKeysForOr

protected Collection<String> memberOfGroupKeysForOr

Constructor Details

PlatformUserQueryImpl

public PlatformUserQueryImpl()

PlatformUserQueryImpl

public PlatformUserQueryImpl(CommandContext commandContext,
 CoreIdmEngineConfiguration idmEngineConfiguration)

PlatformUserQueryImpl

public PlatformUserQueryImpl(CommandExecutor commandExecutor,
 CoreIdmEngineConfiguration idmEngineConfiguration)

Method Details

executeFindUserCount

protected long executeFindUserCount(CommandContext commandContext)

Specified by:

executeFindUserCount in class UserBaseQueryImpl<PlatformUserQuery,PlatformUser>

executeFindUserList

protected List<PlatformUser> executeFindUserList(CommandContext commandContext)

Specified by:

executeFindUserList in class UserBaseQueryImpl<PlatformUserQuery,PlatformUser>

userIdsNotIn

public PlatformUserQuery userIdsNotIn(List<String> ids)

Specified by:

userIdsNotIn in interface PlatformUserQuery

userDefinitionKey

public PlatformUserQuery userDefinitionKey(String userDefinitionKey)

Specified by:

userDefinitionKey in interface PlatformUserQuery

type

public PlatformUserQuery type(String type)

Description copied from interface: PlatformUserQuery

Query for users of the given type

Specified by:

type in interface PlatformUserQuery

See Also:

• for known user types

subType

public PlatformUserQuery subType(String subType)

Specified by:

subType in interface PlatformUserQuery

presence

public PlatformUserQuery presence(String presence)

Description copied from interface: PlatformUserQuery

Query for users with the given presence status.

Specified by:

presence in interface PlatformUserQuery

See Also:

• for known presence states

accessibleByUser

public PlatformUserQuery accessibleByUser(String userId)

Description copied from interface: PlatformUserQuery

Query all users that are accessible by the user with the provided userId.

Specified by:

accessibleByUser in interface PlatformUserQuery

Parameters:

userId - the if of the user for which users should be queried

accessibleByUserWithUserDefinitionKey

public PlatformUserQuery accessibleByUserWithUserDefinitionKey(String userId,
 String userDefinitionKey)

Description copied from interface: PlatformUserQuery

Query all users that are accessible by the user with the provided userId and userDefinitionKey.

Specified by:

accessibleByUserWithUserDefinitionKey in interface PlatformUserQuery

Parameters:

userId - the id of the user for which users should be queried

userDefinitionKey - the user definition key for the user for which users should be queried

active

public PlatformUserQuery active()

Specified by:

active in interface PlatformUserQuery

state

public PlatformUserQuery state(String state)

Specified by:

state in interface PlatformUserQuery

subState

public PlatformUserQuery subState(String subState)

Specified by:

subState in interface PlatformUserQuery

infoEquals

public PlatformUserQuery infoEquals(String name,
 Object value)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value.

Specified by:

infoEquals in interface PlatformUserQuery

Parameters:

name - the name of the info

value - the value that the info should have

infoEqualsIgnoreCase

public PlatformUserQuery infoEqualsIgnoreCase(String name,
 String value)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value ignoring the case of the value.

Specified by:

infoEqualsIgnoreCase in interface PlatformUserQuery

Parameters:

name - the name of the info

value - the value that the info should have

infoValueLike

public PlatformUserQuery infoValueLike(String name,
 String infoValueLike)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value like.

Specified by:

infoValueLike in interface PlatformUserQuery

Parameters:

name - the name of the info

infoValueLike - the value like the info should have ('%' has to be added by the caller itself)

infoValueLikeIgnoreCase

public PlatformUserQuery infoValueLikeIgnoreCase(String name,
 String infoValueLike)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value like ignoring the case of the value.

Specified by:

infoValueLikeIgnoreCase in interface PlatformUserQuery

Parameters:

name - the name of the info

infoValueLike - the value like the info should have ('%' has to be added by the caller itself)

createAfter

public PlatformUserQuery createAfter(Date createdAfter)

Specified by:

createAfter in interface PlatformUserQuery

createdBefore

public PlatformUserQuery createdBefore(Date createdBefore)

Specified by:

createdBefore in interface PlatformUserQuery

includeIdentityInfo

@Deprecated
public PlatformUserQuery includeIdentityInfo()

Deprecated.

Description copied from interface: PlatformUserQuery

Query the user including the extra identity info. Implementations are allowed to include the identity info even without explicitly invoking this.

Specified by:

includeIdentityInfo in interface PlatformUserQuery

withoutTenantId

public PlatformUserQuery withoutTenantId()

Description copied from interface: PlatformUserQuery

Query only users belonging to no tenant.

Specified by:

withoutTenantId in interface PlatformUserQuery

memberOfGroupKey

public PlatformUserQuery memberOfGroupKey(String groupKey)

Description copied from interface: PlatformUserQuery

Only select PlatformUsers that belong to the group with the given key.

Specified by:

memberOfGroupKey in interface PlatformUserQuery

memberOfGroupKeys

public PlatformUserQuery memberOfGroupKeys(Collection<String> groupKeys)

Description copied from interface: PlatformUserQuery

Only select PlatformUsers that belong to the groups with the given keys.

Specified by:

memberOfGroupKeys in interface PlatformUserQuery

userIdsOrMemberOfGroupKeys

public PlatformUserQuery userIdsOrMemberOfGroupKeys(Collection<String> userIds,
 Collection<String> groupKeys)

Description copied from interface: PlatformUserQuery

Only select PlatformUsers with the given user ids or that belong to the groups with the given keys.

Specified by:

userIdsOrMemberOfGroupKeys in interface PlatformUserQuery

createNewQuery

protected PlatformUserQueryImpl createNewQuery(CommandContext commandContext,
 CoreIdmEngineConfiguration idmEngineConfiguration)

Specified by:

createNewQuery in class UserBaseQueryImpl<PlatformUserQuery,PlatformUser>

getNotInIds

public List<String> getNotInIds()

isWithoutTenantId

public boolean isWithoutTenantId()