Package de.espirit.firstspirit.scheduling.agency

Interface FileEntry

public interface FileEntry
File entry providing information about a file created within a generation process.
Since:
5.2.200905

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable IDProvider
    getElement(BaseContext context, boolean release)
    Provides the element this file is based upon with respect to the given context.
    @Nullable String
    getElementUid()
    Provides the UID of the element, this file is based upon.
    IDProvider.UidType
    getElementUidType()
    Provides the UID-Type of the element, this file is based upon.
    @NotNull String
    getExtension()
    Provides the extension of the file.
    @NotNull String
    getName()
    Provides the name of the file.
    @NotNull String
    getPath()
    Provides the complete path sequence (including the file's name) relative to the root of the generation.

  • Method Details

    • getName

      @NotNull @NotNull String getName()
      Provides the name of the file. This is the last name in the file path's name sequence.
      Returns:
      The file's name.
      Since:
      5.2.200905

    • getExtension

      @NotNull @NotNull String getExtension()
      Provides the extension of the file.
      Returns:
      The file's extension.
      Since:
      5.2.200905

    • getPath

      @NotNull @NotNull String getPath()
      Provides the complete path sequence (including the file's name) relative to the root of the generation.
      Returns:
      The path of this file.
      Since:
      5.2.200905

    • getElementUid

      @Nullable @Nullable String getElementUid()
      Provides the UID of the element, this file is based upon.
      Returns:
      The element's UID or null, if the element does not have a uid.
      Since:
      5.2.200905

    • getElementUidType

      @Nullable IDProvider.UidType getElementUidType()
      Provides the UID-Type of the element, this file is based upon.
      Returns:
      The element's UID-Type or null, if the element type is unknown.
      Since:
      5.2.200905

    • getElement

      @Nullable @Nullable IDProvider getElement(BaseContext context, boolean release)
      Provides the element this file is based upon with respect to the given context. If release is defined true, the element will be fetched in its released version (read only), otherwise in its current version (modifiable).

      Note that for content projection based files, the element will be the defining PageRef and not the dataset.

      Parameters:
      context - The context providing access information.
      release - Indicates to fetch the released version of elements.
      Returns:
      The related element.
      Since:
      5.2.200905