Package com.idmedia.translationstudio.firstspirit.api

Class TranslationStudioRequestData<T extends de.espirit.firstspirit.access.store.IDProvider>

java.lang.Object
com.idmedia.translationstudio.firstspirit.api.TranslationStudioRequestData<T>
Type Parameters:
T -
Direct Known Subclasses:
TranslationStudioRequestDataDatasets, TranslationStudioRequestDataPages
public abstract class TranslationStudioRequestData<T extends de.espirit.firstspirit.access.store.IDProvider> extends Object
Author:
Phillip Austerfield

  • Method Details

    • createResult

      @NotNull public ITranslationStudioRequestData createResult()
      Create a result object
      Returns:

    • addCustomData

      public void addCustomData(@NotNull String sFieldName, @NotNull String sValue)
      Add a custom data field, such as additional text field
      Parameters:
      sFieldName - Field Name
      sValue - Content

    • addElement

      public abstract boolean addElement(@NotNull T pElement)
      Add translatable element
      Parameters:
      pElement -
      Returns:
      Success state

    • setDueDate

      public void setDueDate(@Nullable Date pDate)
      Set due date
      Parameters:
      pDate -

    • setTranslateImmediately

      public void setTranslateImmediately(boolean bValue)
      Set Immediate Translation flag (bypasses quotes)
      Parameters:
      bValue - Value

    • setCreatePreviewPage

      public void setCreatePreviewPage(boolean bCreate)
      Should preview pages be created (false is default)
      Parameters:
      bCreate -

    • setWorkflowOnImport

      public void setWorkflowOnImport(long lId)
      Set the worklow to be execued on given elements upon import (if possible)
      Parameters:
      lId -

    • setKeepNontranslatables

      public void setKeepNontranslatables(boolean bKeep)

    • setIsFragementCreatorProject

      public void setIsFragementCreatorProject(boolean bIsFragment)
      Set TRUE if this project represents a fragment creator project
      Parameters:
      bIsFragment -

    • setNotitifactionUserId

      public void setNotitifactionUserId(long lUserId)
      Set ID of user to receive status update emails
      Parameters:
      lUserId -

    • hasLanguageMappings

      public boolean hasLanguageMappings()
      Check if language mappings are available
      Returns:

    • hasElements

      public boolean hasElements()
      Check if there are translation elements available
      Returns:

    • isEmpty

      public boolean isEmpty()
      Check if elements and mappings are available
      Returns:

    • addTranslationLanguages

      public boolean addTranslationLanguages(@NotNull de.espirit.firstspirit.access.Language pSourceLanguage, @NotNull de.espirit.firstspirit.access.Language pTargetLanguage, @NotNull String sConnectorId)
      Add a translation language pair
      Parameters:
      pSourceLanguage -
      pTargetLanguage -
      sConnectorId -
      Returns:
      Success state