Interface IEntityExportNameProvider<Entity>

Type Parameters:
Entity - The type of the entity.
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@Deprecated @FunctionalInterface public interface IEntityExportNameProvider<Entity>
Deprecated.
Should only be used on file entities.

When exporting a set of entities to a ZIP archive, for each file entity, a file with the binary data of the file entity needs to be created. This interface provides custom logic for the name of that file. By default, the UUID is used if the file entity possesses a UUID, otherwise its file name is used.

Since:
8.3.0
Author:
XIMA Media GmbH
  • Method Summary

    Modifier and Type
    Method
    Description
    createFileName(Entity fileEntity, Object baseEntity)
    Deprecated.
    Creates the file name to use for the given file entity.
    default boolean
    isMatchesFileName(Entity entity, Object baseEntity, String fileName)
    Deprecated.
    Tests whether the given file name matches the file name of the given file entity.
  • Method Details

    • createFileName

      String createFileName(Entity fileEntity, Object baseEntity)
      Deprecated.
      Creates the file name to use for the given file entity.
      Parameters:
      fileEntity - The file entity.
      baseEntity - Optional base entity containing the file entity. May be null when not available.
      Returns:
      The file name.
    • isMatchesFileName

      default boolean isMatchesFileName(Entity entity, Object baseEntity, String fileName)
      Deprecated.
      Tests whether the given file name matches the file name of the given file entity. By default, this simply checks whether the file name from createFileName equals the given file name.
      Parameters:
      entity - The entity.
      baseEntity - Optional base entity containing the file entity. May be null when not available.
      fileName - The file name to test.
      Returns:
      Whether the file name matches the file entity.