Package com.idmedia.translationstudio.firstspirit.api

Class TranslationRequestFormGeneric

java.lang.Object
com.idmedia.translationstudio.firstspirit.api.TranslationRequestFormGeneric
All Implemented Interfaces:
ITranslationRequestForm, ITranslationRequestFormLoadableResult
Direct Known Subclasses:
TranslationRequestFormContent2, TranslationRequestFormPage, TranslationStudioRequestFormPageFolder
public class TranslationRequestFormGeneric extends Object implements ITranslationRequestForm
Author:
Phillip Austerfield

  • Method Details

    • translateAllSections

      public boolean translateAllSections()
      Translate all sections
      Specified by:
      translateAllSections in interface ITranslationRequestForm
      Returns:

    • getSectionIds

      @NotNull public List<String> getSectionIds()
      List of Sections Ids which are to be translated
      Specified by:
      getSectionIds in interface ITranslationRequestForm
      Returns:

    • translatePageForm

      public boolean translatePageForm()
      Also translate Page form
      Specified by:
      translatePageForm in interface ITranslationRequestForm
      Returns:

    • addLanguageMappingsPage

      public void addLanguageMappingsPage(@NotNull de.espirit.firstspirit.access.store.pagestore.Page pPage)
      Add a language mapping (source-target language GCA page) to use
      Parameters:
      pPage -

    • getMappingsPage

      @NotNull public List<de.espirit.firstspirit.access.store.pagestore.Page> getMappingsPage()
      Get Content Page to be translated
      Specified by:
      getMappingsPage in interface ITranslationRequestForm
      Returns:
      Page

    • setCompletionDate

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

    • getCompletionDate

      @Nullable public Date getCompletionDate()
      Get Completion Date
      Specified by:
      getCompletionDate in interface ITranslationRequestForm
      Returns:
      Date

    • getEntities

      @NotNull public List<String> getEntities()
      get a list of all entity gids
      Specified by:
      getEntities in interface ITranslationRequestForm
      Returns:

    • translateImmediately

      public void translateImmediately(boolean bImmediately)
      Urgency information
      Parameters:
      bImmediately -

    • translateImmediately

      public boolean translateImmediately()
      Translate page immediately
      Specified by:
      translateImmediately in interface ITranslationRequestForm
      Returns:

    • registerPagesRecursively

      public boolean registerPagesRecursively()
      Register pages recursivly
      Specified by:
      registerPagesRecursively in interface ITranslationRequestForm
      Returns:

    • createPreviewPage

      public boolean createPreviewPage()
      Should preview pages be created?
      Specified by:
      createPreviewPage in interface ITranslationRequestForm
      Returns:

    • setWorkflowOnImportId

      public void setWorkflowOnImportId(long lId)
      Set workflow id to be executed upon successful import
      Parameters:
      lId -

    • getWorkflowOnImportId

      public long getWorkflowOnImportId()
      Get Id of workflow to be imported after successful element import
      Specified by:
      getWorkflowOnImportId in interface ITranslationRequestForm
      Returns:
      Id or -1 on error

    • keepNontranslatables

      public void keepNontranslatables(boolean bKeep)
      Copy non-translatables
      Parameters:
      bKeep -

    • keepNontranslatables

      public boolean keepNontranslatables()
      Keep non-translatable input components in the XML instead of removing them
      Specified by:
      keepNontranslatables in interface ITranslationRequestForm
      Returns:

    • isFragment

      public boolean isFragment()
      Indicate that this is not a fragment project
      Specified by:
      isFragment in interface ITranslationRequestForm
      Returns:

    • getTaskTicketContent2

      public de.espirit.firstspirit.access.store.contentstore.Content2 getTaskTicketContent2()
      Get Task Ticket Content2 Instance
      Specified by:
      getTaskTicketContent2 in interface ITranslationRequestForm
      Returns:
      Instance or null

    • getTaskListContent2

      public 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
      Specified by:
      getTaskListContent2 in interface ITranslationRequestForm
      Returns:
      Instance or null

    • getTaskTicketContent2Tpl

      public de.espirit.firstspirit.access.store.templatestore.TableTemplate getTaskTicketContent2Tpl()
      Get Task Ticket Content2 Template
      Specified by:
      getTaskTicketContent2Tpl in interface ITranslationRequestForm
      Returns:
      Template or null

    • getTaskListContent2Tpl

      public 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
      Specified by:
      getTaskListContent2Tpl in interface ITranslationRequestForm
      Returns:
      Template or null

    • setCustomFieldsXml

      public void setCustomFieldsXml(String sXml)
      Set custom message XML information
      Parameters:
      sXml -

    • getCustomFieldsXml

      public String getCustomFieldsXml()
      Get XML of custom fields
      Specified by:
      getCustomFieldsXml in interface ITranslationRequestForm
      Returns:

    • notifyUser

      public void notifyUser(boolean bSendMails)
      Should user receive emails?
      Parameters:
      bSendMails -

    • notifyUser

      public boolean notifyUser()
      Send user notification on status change
      Specified by:
      notifyUser in interface ITranslationRequestForm
      Returns:

    • getGenerationTaskPreviewExecutor

      @Deprecated public String getGenerationTaskPreviewExecutor()
      Deprecated.
      Get ScheduledTask name which will execute preview task
      Specified by:
      getGenerationTaskPreviewExecutor in interface ITranslationRequestForm
      Returns:
      Task name or empty string

    • getGenerationTaskQueue

      @Deprecated public String getGenerationTaskQueue()
      Deprecated.
      Get ScheduledTask without Preview
      Specified by:
      getGenerationTaskQueue in interface ITranslationRequestForm
      Returns:
      Task name or empty string

    • load

      public boolean load(de.espirit.firstspirit.forms.FormData pForm, de.espirit.firstspirit.access.project.Project pProject)
      Can be ignored.
      Specified by:
      load in interface ITranslationRequestFormLoadableResult
      Parameters:
      pForm -
      pProject -
      Returns:
      Always true

    • getTmsProjectOverwrite

      public String getTmsProjectOverwrite()
      Specified by:
      getTmsProjectOverwrite in interface ITranslationRequestForm

    • setTmsProjectOverwrite

      public void setTmsProjectOverwrite(String sTmsProjectOverwrite)

    • translateDeltaOnly

      public boolean translateDeltaOnly()
      Description copied from interface: ITranslationRequestForm
      Translate only untranslated text (if possible)
      Specified by:
      translateDeltaOnly in interface ITranslationRequestForm
      Returns:

    • setTranslateDeltaOnly

      public void setTranslateDeltaOnly(boolean bTranslateDeltaOnly)

    • onlyTranslateReleasedElements

      public boolean onlyTranslateReleasedElements()
      Description copied from interface: ITranslationRequestForm
      Only translate released pages/datasets
      Specified by:
      onlyTranslateReleasedElements in interface ITranslationRequestForm
      Returns:

    • setOnlyTranslateReleasedElements

      public void setOnlyTranslateReleasedElements(boolean bOnlyTranslated)