Package com.flowable.core.idm.api

Interface PlatformUserQuery

All Superinterfaces:

org.flowable.common.engine.api.query.Query<PlatformUserQuery,PlatformUser>, org.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>

All Known Implementing Classes:

LdapUserQuery, PlatformUserQueryImpl

public interface PlatformUserQuery
extends org.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>

Nested Class Summary

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

org.flowable.common.engine.api.query.Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method	Description
PlatformUserQuery	accessibleByUser(java.lang.String userId)	Deprecated. use accessibleByUserWithUserDefinitionKey(String, String) instead
PlatformUserQuery	accessibleByUserWithUserDefinitionKey(java.lang.String userId, java.lang.String userDefinitionKey)	Query all users that are accessible by the user with the provided userId and userDefinitionKey.
PlatformUserQuery	active()
PlatformUserQuery	createAfter(java.util.Date createdAfter)
PlatformUserQuery	createdBefore(java.util.Date createdBefore)
PlatformUserQuery	includeIdentityInfo()	Query the user including the extra identity info.
PlatformUserQuery	infoEquals(java.lang.String name, java.lang.Object value)	Checks for a user with the given info name and value.
PlatformUserQuery	infoEqualsIgnoreCase(java.lang.String name, java.lang.String value)	Checks for a user with the given info name and value ignoring the case of the value.
PlatformUserQuery	infoValueLike(java.lang.String name, java.lang.String valueLike)	Checks for a user with the given info name and value like.
PlatformUserQuery	infoValueLikeIgnoreCase(java.lang.String name, java.lang.String valueLike)	Checks for a user with the given info name and value like ignoring the case of the value.
PlatformUserQuery	memberOfGroupKey(java.lang.String groupKey)	Only select PlatformUsers that belong to the group with the given key.
PlatformUserQuery	memberOfGroupKeys(java.util.Collection<java.lang.String> groupKeys)	Only select PlatformUsers that belong to the groups with the given keys.
PlatformUserQuery	presence(java.lang.String presence)	Query for users with the given presence status.
PlatformUserQuery	state(java.lang.String state)
PlatformUserQuery	subState(java.lang.String subState)
PlatformUserQuery	subType(java.lang.String subType)
PlatformUserQuery	type(java.lang.String type)	Query for users of the given type
PlatformUserQuery	userDefinitionKey(java.lang.String userDefinitionKey)
PlatformUserQuery	userIdsNotIn(java.util.List<java.lang.String> ids)
PlatformUserQuery	userIdsOrMemberOfGroupKeys(java.util.Collection<java.lang.String> userIds, java.util.Collection<java.lang.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 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

Method Detail

accessibleByUser

@Deprecated
PlatformUserQuery accessibleByUser(java.lang.String userId)

Deprecated.

use accessibleByUserWithUserDefinitionKey(String, String) instead

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

Parameters:

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

accessibleByUserWithUserDefinitionKey

PlatformUserQuery accessibleByUserWithUserDefinitionKey(java.lang.String userId,
                                                        java.lang.String userDefinitionKey)

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

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

PlatformUserQuery active()

state

PlatformUserQuery state(java.lang.String state)

subState

PlatformUserQuery subState(java.lang.String subState)

userIdsNotIn

PlatformUserQuery userIdsNotIn(java.util.List<java.lang.String> ids)

userDefinitionKey

PlatformUserQuery userDefinitionKey(java.lang.String userDefinitionKey)

type

PlatformUserQuery type(java.lang.String type)

Query for users of the given type

See Also:

for known user types

subType

PlatformUserQuery subType(java.lang.String subType)

presence

PlatformUserQuery presence(java.lang.String presence)

Query for users with the given presence status.

See Also:

for known presence states

infoEquals

PlatformUserQuery infoEquals(java.lang.String name,
                             java.lang.Object value)

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

Parameters:

name - the name of the info

value - the value that the info should have

infoEqualsIgnoreCase

PlatformUserQuery infoEqualsIgnoreCase(java.lang.String name,
                                       java.lang.String value)

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

Parameters:

name - the name of the info

value - the value that the info should have

infoValueLike

PlatformUserQuery infoValueLike(java.lang.String name,
                                java.lang.String valueLike)

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

Parameters:

name - the name of the info

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

infoValueLikeIgnoreCase

PlatformUserQuery infoValueLikeIgnoreCase(java.lang.String name,
                                          java.lang.String valueLike)

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

Parameters:

name - the name of the info

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

createdBefore

PlatformUserQuery createdBefore(java.util.Date createdBefore)

createAfter

PlatformUserQuery createAfter(java.util.Date createdAfter)

includeIdentityInfo

PlatformUserQuery includeIdentityInfo()

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

withoutTenantId

PlatformUserQuery withoutTenantId()

Query only users belonging to no tenant.

memberOfGroupKey

PlatformUserQuery memberOfGroupKey(java.lang.String groupKey)

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

memberOfGroupKeys

PlatformUserQuery memberOfGroupKeys(java.util.Collection<java.lang.String> groupKeys)

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

userIdsOrMemberOfGroupKeys

PlatformUserQuery userIdsOrMemberOfGroupKeys(java.util.Collection<java.lang.String> userIds,
                                             java.util.Collection<java.lang.String> groupKeys)

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