Package org.flowable.common.engine.api.tenant

Interface TenantContext

All Known Implementing Classes:
ThreadLocalTenantContext
public interface TenantContext
Flowable Tenant context that can be implemented in different ways to hold and store the tenant information.
Author:
Filip Hrisafov

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearTenantId()
    Clears the last set value of the tenant.
    String
    getTenantId()
    The id of the tenant.
    boolean
    isTenantIdSet()
    Flag indicating whether the tenant id is set.
    void
    setTenantId(String tenantId)
    Changes the tenant id with the new value.

  • Method Details

    • getTenantId

      String getTenantId()
      The id of the tenant.
      Returns:
      the id of the tenant

    • setTenantId

      void setTenantId(String tenantId)
      Changes the tenant id with the new value.
      Parameters:
      tenantId - the id of the tenant

    • clearTenantId

      void clearTenantId()
      Clears the last set value of the tenant.

    • isTenantIdSet

      boolean isTenantIdSet()
      Flag indicating whether the tenant id is set.
      Returns:
      true if the tenant id can return a value for getTenantId(), false otherwise