Package org.camunda.bpm.engine.impl

Class GroupQueryImpl

java.lang.Object

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

org.camunda.bpm.engine.impl.AbstractQuery<GroupQuery,Group>

org.camunda.bpm.engine.impl.GroupQueryImpl

All Implemented Interfaces:

Serializable, GroupQuery, Command<Object>, Query<GroupQuery,Group>

Direct Known Subclasses:

DbGroupQueryImpl, LdapGroupQuery, OAuth2IdentityProvider.OAuth2GroupQuery

public abstract class GroupQueryImpl
extends AbstractQuery<GroupQuery,Group>
implements GroupQuery

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	id
protected String[]	ids
protected String	name
protected String	nameLike
protected String	procDefId
protected String	tenantId
protected String	type
protected String	userId

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
GroupQueryImpl()
GroupQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
String	getId()
String[]	getIds()
String	getName()
String	getNameLike()
String	getTenantId()
String	getType()
String	getUserId()
GroupQuery	groupId(String id)	Only select Groups with the given id.
GroupQuery	groupIdIn(String... ids)	Only select Groups with the given ids
GroupQuery	groupMember(String userId)	Only selects Groups where the given user is a member of.
GroupQuery	groupName(String name)	Only select Groups with the given name.
GroupQuery	groupNameLike(String nameLike)	Only select Groups where the name matches the given parameter.
GroupQuery	groupType(String type)	Only select Groups which have the given type.
GroupQuery	memberOfTenant(String tenantId)	Only select Groups that belongs to the given tenant.
GroupQuery	orderByGroupId()	Order by group id (needs to be followed by Query.asc() or Query.desc()).
GroupQuery	orderByGroupName()	Order by group name (needs to be followed by Query.asc() or Query.desc()).
GroupQuery	orderByGroupType()	Order by group type (needs to be followed by Query.asc() or Query.desc()).
GroupQuery	potentialStarter(String procDefId)	Only select GroupS that are potential starter for the given process definition.

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

name

protected String name

nameLike

protected String nameLike

type

protected String type

userId

protected String userId

procDefId

protected String procDefId

tenantId

protected String tenantId

Constructor Details

GroupQueryImpl

public GroupQueryImpl()

GroupQueryImpl

public GroupQueryImpl(CommandExecutor commandExecutor)

Method Details

groupId

public GroupQuery groupId(String id)

Description copied from interface: GroupQuery

Only select Groups with the given id.

Specified by:

groupId in interface GroupQuery

groupIdIn

public GroupQuery groupIdIn(String... ids)

Description copied from interface: GroupQuery

Only select Groups with the given ids

Specified by:

groupIdIn in interface GroupQuery

groupName

public GroupQuery groupName(String name)

Description copied from interface: GroupQuery

Only select Groups with the given name.

Specified by:

groupName in interface GroupQuery

groupNameLike

public GroupQuery groupNameLike(String nameLike)

Description copied from interface: GroupQuery

Only select Groups where the name matches the given parameter. The syntax to use is that of SQL, eg. %activiti%.

Specified by:

groupNameLike in interface GroupQuery

groupType

public GroupQuery groupType(String type)

Description copied from interface: GroupQuery

Only select Groups which have the given type.

Specified by:

groupType in interface GroupQuery

groupMember

public GroupQuery groupMember(String userId)

Description copied from interface: GroupQuery

Only selects Groups where the given user is a member of.

Specified by:

groupMember in interface GroupQuery

potentialStarter

public GroupQuery potentialStarter(String procDefId)

Description copied from interface: GroupQuery

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

Specified by:

potentialStarter in interface GroupQuery

memberOfTenant

public GroupQuery memberOfTenant(String tenantId)

Description copied from interface: GroupQuery

Only select Groups that belongs to the given tenant.

Specified by:

memberOfTenant in interface GroupQuery

orderByGroupId

public GroupQuery orderByGroupId()

Description copied from interface: GroupQuery

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

Specified by:

orderByGroupId in interface GroupQuery

orderByGroupName

public GroupQuery orderByGroupName()

Description copied from interface: GroupQuery

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

Specified by:

orderByGroupName in interface GroupQuery

orderByGroupType

public GroupQuery orderByGroupType()

Description copied from interface: GroupQuery

Order by group type (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByGroupType in interface GroupQuery

getId

public String getId()

getName

public String getName()

getNameLike

public String getNameLike()

getType

public String getType()

getUserId

public String getUserId()

getTenantId

public String getTenantId()

getIds

public String[] getIds()