Package org.camunda.bpm.engine.impl

Class TenantQueryImpl

java.lang.Object

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

org.camunda.bpm.engine.impl.AbstractQuery<TenantQuery,Tenant>

org.camunda.bpm.engine.impl.TenantQueryImpl

All Implemented Interfaces:

Serializable, TenantQuery, Command<Object>, Query<TenantQuery,Tenant>

Direct Known Subclasses:

DbTenantQueryImpl, LdapTenantQuery

public abstract class TenantQueryImpl
extends AbstractQuery<TenantQuery,Tenant>
implements TenantQuery

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	groupId
protected String	id
protected String[]	ids
protected boolean	includingGroups
protected String	name
protected String	nameLike
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
TenantQueryImpl()
TenantQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
String	getGroupId()
String	getId()
String[]	getIds()
String	getName()
String	getNameLike()
String	getUserId()
TenantQuery	groupMember(String groupId)	Only select Tenants where the given group is member of.
TenantQuery	includingGroupsOfUser(boolean includingGroups)	Selects the Tenants which belongs to one of the user's groups.
boolean	isIncludingGroups()
TenantQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
TenantQuery	orderByTenantName()	Order by tenant name (needs to be followed by Query.asc() or Query.desc()).
TenantQuery	tenantId(String id)	Only select Tenants with the given id.
TenantQuery	tenantIdIn(String... ids)	Only select Tenants with the given ids
TenantQuery	tenantName(String name)	Only select Tenants with the given name.
TenantQuery	tenantNameLike(String nameLike)	Only select Tenants where the name matches the given parameter.
TenantQuery	userMember(String userId)	Only select Tenants where the given user is member of.

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.impl.interceptor.Command

isRetryable

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

userId

protected String userId

groupId

protected String groupId

includingGroups

protected boolean includingGroups

Constructor Details

TenantQueryImpl

public TenantQueryImpl()

TenantQueryImpl

public TenantQueryImpl(CommandExecutor commandExecutor)

Method Details

tenantId

public TenantQuery tenantId(String id)

Description copied from interface: TenantQuery

Only select Tenants with the given id.

Specified by:

tenantId in interface TenantQuery

tenantIdIn

public TenantQuery tenantIdIn(String... ids)

Description copied from interface: TenantQuery

Only select Tenants with the given ids

Specified by:

tenantIdIn in interface TenantQuery

tenantName

public TenantQuery tenantName(String name)

Description copied from interface: TenantQuery

Only select Tenants with the given name.

Specified by:

tenantName in interface TenantQuery

tenantNameLike

public TenantQuery tenantNameLike(String nameLike)

Description copied from interface: TenantQuery

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

Specified by:

tenantNameLike in interface TenantQuery

userMember

public TenantQuery userMember(String userId)

Description copied from interface: TenantQuery

Only select Tenants where the given user is member of.

Specified by:

userMember in interface TenantQuery

groupMember

public TenantQuery groupMember(String groupId)

Description copied from interface: TenantQuery

Only select Tenants where the given group is member of.

Specified by:

groupMember in interface TenantQuery

includingGroupsOfUser

public TenantQuery includingGroupsOfUser(boolean includingGroups)

Description copied from interface: TenantQuery

Selects the Tenants which belongs to one of the user's groups. Can only be used in combination with TenantQuery.userMember(String)

Specified by:

includingGroupsOfUser in interface TenantQuery

orderByTenantId

public TenantQuery orderByTenantId()

Description copied from interface: TenantQuery

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

Specified by:

orderByTenantId in interface TenantQuery

orderByTenantName

public TenantQuery orderByTenantName()

Description copied from interface: TenantQuery

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

Specified by:

orderByTenantName in interface TenantQuery

getId

public String getId()

getName

public String getName()

getNameLike

public String getNameLike()

getIds

public String[] getIds()

getUserId

public String getUserId()

getGroupId

public String getGroupId()

isIncludingGroups

public boolean isIncludingGroups()