Interface IMandantDao

All Superinterfaces:
de.xima.cmn.dao.interfaces.IAbstractDao<Mandant, Long, IEntityContext>, IGenericDao<Mandant>
All Known Implementing Classes:
MandantDao
public interface IMandantDao extends IGenericDao<Mandant>

  • Method Details

    • getInstance

      static IMandantDao getInstance()
      Returns the instance of this DAO via CDI.
      Returns:
      The instance of this DAO.

    • isCreationAllowed

      boolean isCreationAllowed(IEntityContext ec, Mandant mandant)

    • readByName

      Mandant readByName(IEntityContext ec, String name)
      Method for determining a clients by its name (case insensitive).
      Parameters:
      ec - Entity context to use for accessing the database.
      name - The name of the client to search for (case insensitive).
      Returns:
      The client with the given name, or null if no such client exists.

    • getAllByName

      List<Mandant> getAllByName(IEntityContext ec, String name)
      Method for determining all clients by its name (case insensitive).
      Parameters:
      ec - Entity context to use for accessing the database.
      name - The name of the client to search for (case insensitive).
      Returns:
      All clients with the given name, never null.
      Since:
      6.0.1

    • getByUUID

      Mandant getByUUID(IEntityContext ec, String uuid)
      Returns the client with the given UUID
      Parameters:
      ec - Entity context to use for accessing the database.
      uuid - String UUID of the client
      Returns:
      The client with the given UUID, or null when no such client exists.

    • getByUUID

      Mandant getByUUID(IEntityContext ec, UUID uuid)
      Returns the client with the given UUID
      Parameters:
      ec - Entity context to use for accessing the database.
      uuid - UUID of the client
      Returns:
      Mandant for the given UUID
      Since:
      6.1.0

    • getUsedFileSize

      long getUsedFileSize(IEntityContext ec, Mandant mandant)

    • getLicenseDataSnapshot

      LicenseDataSnapshot getLicenseDataSnapshot(IEntityContext ec, Mandant client)

    • getDefaultFormFormThemeByClient

      FormThemeReference getDefaultFormFormThemeByClient(IEntityContext ec, Mandant client)
      Finds the configured default form theme. A default can be configured for each client (optional) and for the entire system as a fallback.
      • If a client was given and the client has a default form theme, return that.
      • If the system-wide form theme was configured, return that.
      • Otherwise, the system is misconfigured. Return the modern form theme.
      Parameters:
      ec - Entity context to use for accessing the database.
      client - The client scope where to look for the default form theme. Can be null, then only the system scope is considered.
      Returns:
      The default form theme for the given client or the system-wide default form theme.

    • getByDefaultFormTheme

      List<Mandant> getByDefaultFormTheme(IEntityContext ec, FormThemeReference formThemeReference)
      Finds all clients that have the given form theme configured as their default form theme. The returned list does not include clients that use the default system form theme.
      Parameters:
      ec - Entity context to use for accessing the database.
      formThemeReference - The form theme to search for.
      Returns:
      All clients that have the given form theme configured as their default form theme.

    • getByDefaultFormThemePlugin

      List<Mandant> getByDefaultFormThemePlugin(IEntityContext ec, String formThemePluginKey)
      Finds all clients that have one of the themes from the given form theme plugin configured as their default form theme. The returned list does not include clients that use the default system form theme.
      Parameters:
      ec - Entity context to use for accessing the database.
      formThemePluginKey - The key of the form theme plugin to search for.
      Returns:
      All clients that have one of the themes from the given form theme plugin configured as their default form theme.