org.flowable.idm.api

Interface GroupQuery

All Superinterfaces:

Query<GroupQuery,Group>

public interface GroupQuery
extends Query<GroupQuery,Group>

Allows to programmatically query for Groups.

Author:

Joram Barrez

Nested Class Summary

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

Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method and Description
GroupQuery	groupId(String groupId) Only select Groups with the given id.
GroupQuery	groupIds(List<String> groupIds) Only select Groups with the given ids.
GroupQuery	groupMember(String groupMemberUserId) Only selects Groups where the given user is a member of.
GroupQuery	groupMembers(List<String> groupMemberUserIds) Only selects Groups where the given users are a member of.
GroupQuery	groupName(String groupName) Only select Groups with the given name.
GroupQuery	groupNameLike(String groupNameLike) Only select Groups where the name matches the given parameter.
GroupQuery	groupNameLikeIgnoreCase(String groupNameLikeIgnoreCase) Only select Groups where the name matches the given parameter (ignoring case).
GroupQuery	groupType(String groupType) 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 interface org.flowable.common.engine.api.query.Query

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

Method Detail

groupId

GroupQuery groupId(String groupId)

Only select Groups with the given id.

groupIds

GroupQuery groupIds(List<String> groupIds)

Only select Groups with the given ids.

groupName

GroupQuery groupName(String groupName)

Only select Groups with the given name.

groupNameLike

GroupQuery groupNameLike(String groupNameLike)

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

groupNameLikeIgnoreCase

GroupQuery groupNameLikeIgnoreCase(String groupNameLikeIgnoreCase)

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

groupType

GroupQuery groupType(String groupType)

Only select Groups which have the given type.

groupMember

GroupQuery groupMember(String groupMemberUserId)

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

groupMembers

GroupQuery groupMembers(List<String> groupMemberUserIds)

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

orderByGroupId

GroupQuery orderByGroupId()

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

orderByGroupName

GroupQuery orderByGroupName()

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

orderByGroupType

GroupQuery orderByGroupType()

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