Package com.idmedia.translationstudio.api.firstspirit

Interface ITranslationRequestForm

All Superinterfaces:
ITranslationRequestFormLoadableResult
All Known Subinterfaces:
ITranslationRequestMultiplePagesForm, ITranslationRequestPageFolderContextFreeForm
All Known Implementing Classes:
TranslationRequestFormContent2, TranslationRequestFormGeneric, TranslationRequestFormPage, TranslationStudioRequestFormPageFolder
public interface ITranslationRequestForm extends ITranslationRequestFormLoadableResult
Basic Language Mappings Form used by Scripts
Author:
Phillip Austerfield.

  • Method Details

    • translateAllSections

      boolean translateAllSections()
      Translate all sections
      Returns:

    • getSectionIds

      @NotNull List<String> getSectionIds()
      List of Sections Ids which are to be translated
      Returns:

    • translatePageForm

      boolean translatePageForm()
      Also translate Page form
      Returns:

    • getMappingsPage

      @NotNull List<de.espirit.firstspirit.access.store.pagestore.Page> getMappingsPage()
      Get Content Page to be translated
      Returns:
      Page

    • getTmsProjectOverwrite

      @NotNull String getTmsProjectOverwrite()

    • getCompletionDate

      @Nullable Date getCompletionDate()
      Get Completion Date
      Returns:
      Date

    • getEntities

      @NotNull List<String> getEntities()
      get a list of all entity gids
      Returns:

    • translateImmediately

      boolean translateImmediately()
      Translate page immediately
      Returns:

    • registerPagesRecursively

      boolean registerPagesRecursively()
      Register pages recursivly
      Returns:

    • createPreviewPage

      boolean createPreviewPage()
      Should preview pages be created?
      Returns:

    • getWorkflowOnImportId

      long getWorkflowOnImportId()
      Get Id of workflow to be imported after successful element import
      Returns:
      Id or -1 on error

    • keepNontranslatables

      boolean keepNontranslatables()
      Keep non-translatable input components in the XML instead of removing them
      Returns:

    • translateDeltaOnly

      boolean translateDeltaOnly()
      Translate only untranslated text (if possible)
      Returns:

    • isFragment

      boolean isFragment()
      Keep non-translatable input components in the XML instead of removing them
      Returns:

    • getTaskTicketContent2

      @Nullable de.espirit.firstspirit.access.store.contentstore.Content2 getTaskTicketContent2()
      Get Task Ticket Content2 Instance
      Returns:
      Instance or null

    • getTaskListContent2

      @Nullable de.espirit.firstspirit.access.store.contentstore.Content2 getTaskListContent2()
      Get Task List Content2 Instance. This is the list which only holds information about the actual task tickets to be commited
      Returns:
      Instance or null

    • getTaskTicketContent2Tpl

      @Nullable de.espirit.firstspirit.access.store.templatestore.TableTemplate getTaskTicketContent2Tpl()
      Get Task Ticket Content2 Template
      Returns:
      Template or null

    • getTaskListContent2Tpl

      @Nullable de.espirit.firstspirit.access.store.templatestore.TableTemplate getTaskListContent2Tpl()
      Get Task List Content2 Template. This is the list which only holds information about the actual task tickets to be commited
      Returns:
      Template or null

    • getCustomFieldsXml

      @NotNull String getCustomFieldsXml()
      Get XML of custom fields
      Returns:

    • notifyUser

      boolean notifyUser()
      Send user notification on status change
      Returns:

    • getGenerationTaskPreviewExecutor

      @NotNull @Deprecated String getGenerationTaskPreviewExecutor()
      Deprecated.
      Get ScheduledTask name which will execute preview task
      Returns:
      Task name or empty string

    • getGenerationTaskQueue

      @NotNull @Deprecated String getGenerationTaskQueue()
      Deprecated.
      Get ScheduledTask without Preview
      Returns:
      Task name or empty string

    • onlyTranslateReleasedElements

      boolean onlyTranslateReleasedElements()
      Only translate released pages/datasets
      Returns: