Package org.camunda.bpm.engine.impl

Class UserQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<UserQuery,User>

org.camunda.bpm.engine.impl.UserQueryImpl

All Implemented Interfaces:

Serializable, UserQuery, Command<Object>, Query<UserQuery,User>

Direct Known Subclasses:

DbUserQueryImpl, LdapUserQueryImpl, OAuth2IdentityProvider.OAuth2UserQuery

public abstract class UserQueryImpl
extends AbstractQuery<UserQuery,User>
implements UserQuery

Author:

Joram Barrez

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field	Description
protected String	email
protected String	emailLike
protected String	firstName
protected String	firstNameLike
protected String	groupId
protected String	id
protected String[]	ids
protected String	lastName
protected String	lastNameLike
protected String	procDefId
protected String	tenantId

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor	Description
UserQueryImpl()
UserQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
String	getEmail()
String	getEmailLike()
String	getFirstName()
String	getFirstNameLike()
String	getGroupId()
String	getId()
String[]	getIds()
String	getLastName()
String	getLastNameLike()
String	getTenantId()
UserQuery	memberOfGroup(String groupId)	Only select Users that belong to the given group.
UserQuery	memberOfTenant(String tenantId)	Only select Users 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 UserS that are potential starter for the given process definition.
UserQuery	userEmail(String email)	Only those Users with the given email addres.
UserQuery	userEmailLike(String emailLike)	Only select Users where the email matches the given parameter.
UserQuery	userFirstName(String firstName)	Only select Users with the given firstName.
UserQuery	userFirstNameLike(String firstNameLike)	Only select Users where the first name matches the given parameter.
UserQuery	userId(String id)	Only select Users with the given id/
UserQuery	userIdIn(String... ids)	Only select Users with the given ids
UserQuery	userLastName(String lastName)	Only select Users with the given lastName.
UserQuery	userLastNameLike(String lastNameLike)	Only select Users where the last name matches the given parameter.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeCount, executeDeploymentIdMappingsList, executeIdsList, executeList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

asc, count, desc, list, listPage, singleResult, unlimitedList

Field Details

id

protected String id

ids

protected String[] ids

firstName

protected String firstName

firstNameLike

protected String firstNameLike

lastName

protected String lastName

lastNameLike

protected String lastNameLike

email

protected String email

emailLike

protected String emailLike

groupId

protected String groupId

procDefId

protected String procDefId

tenantId

protected String tenantId

Constructor Details

UserQueryImpl

public UserQueryImpl()

UserQueryImpl

public UserQueryImpl(CommandExecutor commandExecutor)

Method Details

userId

public UserQuery userId(String id)

Description copied from interface: UserQuery

Only select Users with the given id/

Specified by:

userId in interface UserQuery

userIdIn

public UserQuery userIdIn(String... ids)

Description copied from interface: UserQuery

Only select Users with the given ids

Specified by:

userIdIn in interface UserQuery

userFirstName

public UserQuery userFirstName(String firstName)

Description copied from interface: UserQuery

Only select Users with the given firstName.

Specified by:

userFirstName in interface UserQuery

userFirstNameLike

public UserQuery userFirstNameLike(String firstNameLike)

Description copied from interface: UserQuery

Only select Users where the first name matches the given parameter. The syntax is that of SQL, eg. %activivi%.

Specified by:

userFirstNameLike in interface UserQuery

userLastName

public UserQuery userLastName(String lastName)

Description copied from interface: UserQuery

Only select Users with the given lastName.

Specified by:

userLastName in interface UserQuery

userLastNameLike

public UserQuery userLastNameLike(String lastNameLike)

Description copied from interface: UserQuery

Only select Users where the last name matches the given parameter. The syntax is that of SQL, eg. %activivi%.

Specified by:

userLastNameLike in interface UserQuery

userEmail

public UserQuery userEmail(String email)

Description copied from interface: UserQuery

Only those Users with the given email addres.

Specified by:

userEmail in interface UserQuery

userEmailLike

public UserQuery userEmailLike(String emailLike)

Description copied from interface: UserQuery

Only select Users where the email matches the given parameter. The syntax is that of SQL, eg. %activivi%.

Specified by:

userEmailLike in interface UserQuery

memberOfGroup

public UserQuery memberOfGroup(String groupId)

Description copied from interface: UserQuery

Only select Users that belong to the given group.

Specified by:

memberOfGroup in interface UserQuery

potentialStarter

public UserQuery potentialStarter(String procDefId)

Description copied from interface: UserQuery

Only select UserS that are potential starter for the given process definition.

Specified by:

potentialStarter in interface UserQuery

memberOfTenant

public UserQuery memberOfTenant(String tenantId)

Description copied from interface: UserQuery

Only select Users that belongs to the given tenant.

Specified by:

memberOfTenant in interface UserQuery

orderByUserId

public UserQuery orderByUserId()

Description copied from interface: UserQuery

Order by user id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByUserId in interface UserQuery

orderByUserEmail

public UserQuery orderByUserEmail()

Description copied from interface: UserQuery

Order by user email (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByUserEmail in interface UserQuery

orderByUserFirstName

public UserQuery orderByUserFirstName()

Description copied from interface: UserQuery

Order by user first name (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByUserFirstName in interface UserQuery

orderByUserLastName

public UserQuery orderByUserLastName()

Description copied from interface: UserQuery

Order by user last name (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByUserLastName in interface UserQuery

getId

public String getId()

getIds

public String[] getIds()

getFirstName

public String getFirstName()

getFirstNameLike

public String getFirstNameLike()

getLastName

public String getLastName()

getLastNameLike

public String getLastNameLike()

getEmail

public String getEmail()

getEmailLike

public String getEmailLike()

getGroupId

public String getGroupId()

getTenantId

public String getTenantId()