TenantQuery (Camunda Platform Javadocs 7.20.0-SNAPSHOT)

All Superinterfaces:

Query<TenantQuery,Tenant>

All Known Implementing Classes:

DbTenantQueryImpl, LdapTenantQuery, TenantQueryImpl
```
public interface TenantQuery
extends Query<TenantQuery,Tenant>
```
Allows to programmatically query for Tenants.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`TenantQuery`	`groupMember(String groupId)`	Only select `Tenant`s where the given group is member of.
`TenantQuery`	`includingGroupsOfUser(boolean includingGroups)`	Selects the `Tenant`s which belongs to one of the user's groups.
`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 tenantId)`	Only select `Tenant`s with the given id.
`TenantQuery`	`tenantIdIn(String... ids)`	Only select `Tenant`s with the given ids
`TenantQuery`	`tenantName(String tenantName)`	Only select `Tenant`s with the given name.
`TenantQuery`	`tenantNameLike(String tenantNameLike)`	Only select `Tenant`s where the name matches the given parameter.
`TenantQuery`	`userMember(String userId)`	Only select `Tenant`s where the given user is member of.

Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList

- Method Detail
  - tenantId
```
TenantQuery tenantId(String tenantId)
```
    Only select Tenants with the given id.
  - tenantIdIn
```
TenantQuery tenantIdIn(String... ids)
```
    Only select Tenants with the given ids
  - tenantName
```
TenantQuery tenantName(String tenantName)
```
    Only select Tenants with the given name.
  - tenantNameLike
```
TenantQuery tenantNameLike(String tenantNameLike)
```
    Only select Tenants where the name matches the given parameter. The syntax to use is that of SQL, eg. %tenant%.
  - userMember
```
TenantQuery userMember(String userId)
```
    Only select Tenants where the given user is member of.
  - groupMember
```
TenantQuery groupMember(String groupId)
```
    Only select Tenants where the given group is member of.
  - includingGroupsOfUser
```
TenantQuery includingGroupsOfUser(boolean includingGroups)
```
    Selects the Tenants which belongs to one of the user's groups. Can only be used in combination with userMember(String)
  - orderByTenantId
```
TenantQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
  - orderByTenantName
```
TenantQuery orderByTenantName()
```
    Order by tenant name (needs to be followed by Query.asc() or Query.desc()).