Package de.xima.fc.dao.interfaces

Interface IPostfachDao

All Superinterfaces:
de.xima.cmn.dao.interfaces.IAbstractDao<Postfach,Long,IEntityContext>, IGenericDao<Postfach>, IMandantDependentBaseDao<Postfach>
All Known Implementing Classes:
PostfachDao
public interface IPostfachDao extends IMandantDependentBaseDao<Postfach>
Data access object for creating, updating, and deleting Postfach entities.
Author:
XIMA MEDIA GmbH

  • Method Details

    • clear

      void clear(IEntityContext ec, Postfach inbox)
      Deletes all form records in the given inbox.
      Parameters:
      ec - Entity context to use for interacting with the database.
      inbox - Inbox to clear.

    • getAllNamesByUserGroups

      Set<String> getAllNamesByUserGroups(IEntityContext ec, Collection<? extends BenutzerGruppe> userGroups)
      Parameters:
      ec - Entity context to use for interacting with the database.
      userGroups - User groups to check.
      Returns:
      The names of all inboxes with access to at least one of the given user groups.
      Since:
      8.0.0

    • getAllNamesByUserGroup

      default Set<String> getAllNamesByUserGroup(IEntityContext ec, BenutzerGruppe userGroup)
      Parameters:
      ec - Entity context to use for interacting with the database.
      userGroup - User group to check.
      Returns:
      The names of all inboxes with access to the given user group.
      Since:
      8.0.0

    • getAllByBenutzergruppe

      default List<Postfach> getAllByBenutzergruppe(IEntityContext ec, BenutzerGruppe userGroup)
      Parameters:
      ec - Entity context to use for interacting with the database.
      userGroup - User group to check.
      Returns:
      All inboxes with access to the given user group.

    • getAllByUserGroups

      List<Postfach> getAllByUserGroups(IEntityContext ec, Collection<? extends BenutzerGruppe> userGroups)
      Parameters:
      ec - Entity context to use for interacting with the database.
      userGroups - User groups to check.
      Returns:
      All inboxes with access to at least one of the given groups.
      Since:
      8.0.0

    • getAllByClient

      List<Postfach> getAllByClient(IEntityContext ec, Mandant client)
      Returns all inboxes of the given client.
      Parameters:
      ec - Entity context to use for interacting with the database.
      client - Client context in which to look for inbox
      Returns:
      A list of inboxes of the given client
      Since:
      6.0.0

    • getByUUID

      Postfach getByUUID(IEntityContext ec, Mandant client, String uuid)
      Returns the inbox with the given UUID
      Parameters:
      ec - Entity context to use for interacting with the database.
      client - Client context in which to look for inbox
      uuid - UUID of the inbox
      Returns:
      The inbox with the given UUID and client, if such an inbox exists.
      Since:
      6.1.0

    • getByUUID

      Postfach getByUUID(IEntityContext ec, Mandant client, UUID uuid)
      Returns the inbox with the given UUID
      Parameters:
      ec - Entity context to use for interacting with the database.
      client - Client context in which to look for inbox
      uuid - UUID UUID of the inbox
      Returns:
      The inbox with the given UUID and client, if such an inbox exists.
      Since:
      6.1.0

    • findUniqueName

      String findUniqueName(IEntityContext ec, Mandant client, String candidate, Postfach exclude)
      Returns a name that is not taken by another Postfach in the given client other than the excluded inbox. An index will be added to the candidate if necessary.
      Parameters:
      ec - Entity context to use for interacting with the database.
      client - Client for which a unique inbox name should be generated
      candidate - Inbox name candidate to be made unique
      exclude - Inbox to be excluded from search
      Returns:
      unique inbox name in the context of the given client
      Since:
      6.6.0

    • isNameExisiting

      boolean isNameExisiting(IEntityContext ec, Mandant client, String name)
      Returns whether or not the given inbox name exists within the given client
      Parameters:
      ec - Entity context to use for interacting with the database.
      client - Client context in which to look for inbox
      name - An inbox name to check
      Returns:
      whether or not the given name is unique
      Since:
      6.6.0

    • clear

      @Deprecated void clear(IEntityContext ec, Mandant client, Postfach inbox)
      Deprecated.
      use clear(IEntityContext, Postfach)
      Deletes all form records in the given inbox.
      Parameters:
      ec - Entity context to use for interacting with the database.
      client - Client to which the inbox belongs.
      inbox - Inbox to clear.

    • getPostfachByBenutzer

      @Deprecated List<Postfach> getPostfachByBenutzer(IEntityContext ec, Benutzer benutzer)
      Deprecated.
      use getAllByUserGroups(IEntityContext, Collection).
      Parameters:
      ec - Entity context to use for interacting with the database.
      benutzer - User for which to find inboxes.
      Returns:
      A list of all inboxes accessible to the given user.