org.flowable.idm.engine.impl

Class GroupQueryImpl

java.lang.Object

org.flowable.common.engine.impl.db.ListQueryParameterObject

org.flowable.common.engine.impl.query.AbstractQuery<GroupQuery,Group>

org.flowable.idm.engine.impl.GroupQueryImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

KeycloakGroupQueryImpl, LDAPGroupQueryImpl

public class GroupQueryImpl
extends AbstractQuery<GroupQuery,Group>
implements GroupQuery, CacheAwareQuery<GroupEntity>

Author:

Joram Barrez

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 and Description
protected String	id
protected List<String>	ids
protected String	name
protected String	nameLike
protected String	nameLikeIgnoreCase
protected String	type
protected String	userId
protected List<String>	userIds

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 and Description
GroupQueryImpl()
GroupQueryImpl(CommandContext commandContext)
GroupQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
long	executeCount(CommandContext commandContext)
List<Group>	executeList(CommandContext commandContext) Executes the actual query to retrieve the list of results.
String	getId()
List<String>	getIds()
String	getName()
String	getNameLike()
String	getNameLikeIgnoreCase()
String	getType()
String	getUserId()
List<String>	getUserIds()
GroupQuery	groupId(String id) Only select Groups with the given id.
GroupQuery	groupIds(List<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	groupMembers(List<String> userIds) Only selects Groups where the given users are 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	groupNameLikeIgnoreCase(String nameLikeIgnoreCase) Only select Groups where the name matches the given parameter (ignoring case).
GroupQuery	groupType(String type) Only select Groups which have the given type.
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()).

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.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Methods inherited from interface org.flowable.common.engine.api.query.CacheAwareQuery

enhanceCachedValue

Field Detail

id

protected String id

ids

protected List<String> ids

name

protected String name

nameLike

protected String nameLike

nameLikeIgnoreCase

protected String nameLikeIgnoreCase

type

protected String type

userId

protected String userId

userIds

protected List<String> userIds

Constructor Detail

GroupQueryImpl

public GroupQueryImpl()

GroupQueryImpl

public GroupQueryImpl(CommandContext commandContext)

GroupQueryImpl

public GroupQueryImpl(CommandExecutor commandExecutor)

Method Detail

groupId

public GroupQuery groupId(String id)

Description copied from interface: GroupQuery

Only select Groups with the given id.

Specified by:

groupId in interface GroupQuery

groupIds

public GroupQuery groupIds(List<String> ids)

Description copied from interface: GroupQuery

Only select Groups with the given ids.

Specified by:

groupIds 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. %test%.

Specified by:

groupNameLike in interface GroupQuery

groupNameLikeIgnoreCase

public GroupQuery groupNameLikeIgnoreCase(String nameLikeIgnoreCase)

Description copied from interface: GroupQuery

Only select Groups where the name matches the given parameter (ignoring case). The syntax to use is that of SQL, eg. %test%.

Specified by:

groupNameLikeIgnoreCase 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

groupMembers

public GroupQuery groupMembers(List<String> userIds)

Description copied from interface: GroupQuery

Only selects Groups where the given users are a member of.

Specified by:

groupMembers 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

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<GroupQuery,Group>

executeList

public List<Group> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<GroupQuery,Group>

getId

public String getId()

Specified by:

getId in interface CacheAwareQuery<GroupEntity>

getIds

public List<String> getIds()

getName

public String getName()

getNameLike

public String getNameLike()

getNameLikeIgnoreCase

public String getNameLikeIgnoreCase()

getType

public String getType()

getUserId

public String getUserId()

getUserIds

public List<String> getUserIds()