Package com.idmedia.translationstudio.api.connector.dao

Interface ITranslatableFile

All Superinterfaces:
ITranslatableFileIdProvider, ITranslatableFileXliff, ITranslatableXmlFile
All Known Subinterfaces:
ITranslatableFileEditable
All Known Implementing Classes:
TranslatableFile
public interface ITranslatableFile extends ITranslatableXmlFile, ITranslatableFileIdProvider, ITranslatableFileXliff
This Interface provides necessary data to identify a file which was uploaded into the TMS System.
Author:
I-D Media AG

  • Method Details

    • getInitialLanguage

      @NotNull @NotNull String getInitialLanguage()
      Returns the target language (initialized in constructor) e.g de_de, fr_fr ...
      Returns:
      Language Code

    • getJobId

      long getJobId()
      Get associated job id
      Returns:

    • isUrgendTranslation

      boolean isUrgendTranslation()
      Indicates that this is an urgent translation
      Returns:

    • getCustomFieldValues

      @NotNull @NotNull List<org.json.simple.JSONObject> getCustomFieldValues()
      Get the values of the custom fields associated with the files in this translatable file
      Returns:
      List, never null

    • getCustomFields

      @NotNull @NotNull List<Map<String,String>> getCustomFields()
      Get a list of custom field maps. Each FirstSpirit FORM field represents a single entry in the map
      Returns:

    • addAdditionalFile

      void addAdditionalFile(String sFile)
      Add a file to the list of preview files
      Parameters:
      sFile - File to be added

    • hasPreviewFiles

      boolean hasPreviewFiles()
      Are preview files available in this package.
      Returns:

    • toJson

      @NotNull @NotNull org.json.simple.JSONObject toJson()
      Store itself as JSON

    • getCmsProjectId

      long getCmsProjectId()

    • getCmsProjectName

      @NotNull @NotNull String getCmsProjectName()
      Get the CMS project name (if available)
      Returns:

    • getDisplayNames

      @NotNull @NotNull List<String> getDisplayNames()
      Get the display names of the CMS file(s) included in this XML file
      Returns:

    • concatinageDisplayNames

      @NotNull @NotNull String concatinageDisplayNames(int nMaxLength)
      Get the display names of the CMS file(s) included in this XML file
      Parameters:
      nMaxLength -
      Returns:

    • getTickets

      @NotNull @Deprecated @NotNull List<String> getTickets()
      Deprecated.

    • getRequestUids

      @NotNull @NotNull List<String> getRequestUids()

    • getRequesterUsers

      @NotNull @NotNull List<String> getRequesterUsers()
      Get the requester's id
      Returns:
      List