org.camunda.bpm.engine.rest.dto.identity

Class UserQueryDto

java.lang.Object

org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

org.camunda.bpm.engine.rest.dto.AbstractQueryDto<UserQuery>

org.camunda.bpm.engine.rest.dto.identity.UserQueryDto

public class UserQueryDto
extends AbstractQueryDto<UserQuery>

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	email
protected String	emailLike
protected String	firstName
protected String	firstNameLike
protected String	id
protected String[]	idIn
protected String	lastName
protected String	lastNameLike
protected String	memberOfGroup
protected String	potentialStarter
protected String	tenantId

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

expressions, SORT_ORDER_ASC_VALUE, SORT_ORDER_DESC_VALUE, sortBy, sortings, sortOrder, VALID_SORT_ORDER_VALUES

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

objectMapper

Constructor Summary

Constructors

Constructor and Description
UserQueryDto()
UserQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyFilters(UserQuery query)
protected void	applySortBy(UserQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected UserQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setEmail(String userEmail)
void	setEmailLike(String userEmailLike)
void	setFirstName(String userFirstName)
void	setFirstNameLike(String userFirstNameLike)
void	setId(String userId)
void	setIdIn(String[] ids)
void	setLastName(String userLastName)
void	setLastNameLike(String userLastNameLike)
void	setMemberOfGroup(String memberOfGroup)
void	setMemberOfTenant(String tenantId)
void	setPotentialStarter(String potentialStarter)

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

applySortingOptions, applySortOrder, getSorting, setSortBy, setSorting, setSortOrder, sortOptionsValid, sortOrderValueForDirection, toQuery

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

setObjectMapper, setValueBasedOnAnnotation

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

idIn

protected String[] idIn

firstName

protected String firstName

firstNameLike

protected String firstNameLike

lastName

protected String lastName

lastNameLike

protected String lastNameLike

email

protected String email

emailLike

protected String emailLike

memberOfGroup

protected String memberOfGroup

potentialStarter

protected String potentialStarter

tenantId

protected String tenantId

Constructor Detail

UserQueryDto

public UserQueryDto()

UserQueryDto

public UserQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
            javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Detail

setId

public void setId(String userId)

setIdIn

public void setIdIn(String[] ids)

setFirstName

public void setFirstName(String userFirstName)

setFirstNameLike

public void setFirstNameLike(String userFirstNameLike)

setLastName

public void setLastName(String userLastName)

setLastNameLike

public void setLastNameLike(String userLastNameLike)

setEmail

public void setEmail(String userEmail)

setEmailLike

public void setEmailLike(String userEmailLike)

setMemberOfGroup

public void setMemberOfGroup(String memberOfGroup)

setPotentialStarter

public void setPotentialStarter(String potentialStarter)

setMemberOfTenant

public void setMemberOfTenant(String tenantId)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<UserQuery>

createNewQuery

protected UserQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<UserQuery>

applyFilters

protected void applyFilters(UserQuery query)

Specified by:

applyFilters in class AbstractQueryDto<UserQuery>

applySortBy

protected void applySortBy(UserQuery query,
               String sortBy,
               Map<String,Object> parameters,
               ProcessEngine engine)

Specified by:

applySortBy in class AbstractQueryDto<UserQuery>