Class TranslationStudio


  • public final class TranslationStudio
    extends Object
    Obtain the TranslationStudio API via get. This is your main starting point. This class provides access to all necessary functions
    Author:
    Phillip Austerfield
    • Constructor Detail

      • TranslationStudio

        public TranslationStudio()
    • Method Detail

      • getTranslationStudioRestOperations

        @NotNull
        public static IRestCommunication getTranslationStudioRestOperations​(de.espirit.firstspirit.agency.SpecialistsBroker pContext)
                                                                     throws IllegalStateException
        Obtain access to REST operations. This will also make sure the access key is used correctly.
        Parameters:
        pContext -
        Returns:
        Throws:
        IllegalStateException
      • getInlineTranslationHelperOCM

        @NotNull
        public static void getInlineTranslationHelperOCM​(@NotNull
                                                         de.espirit.firstspirit.agency.SpecialistsBroker pContext,
                                                         @NotNull
                                                         de.espirit.firstspirit.access.store.pagestore.DataProvider pElement,
                                                         @NotNull
                                                         de.espirit.firstspirit.access.Language pCurrentLanguage)
        Access the TranslationHelper Plugin via OCM interface.The translationhelper component itself is not supported. We need this mechanism, therefore.
        Parameters:
        pContext -
        pElement - Current Element to be translated (page, section)
        pCurrentLanguage - Current ContentCreator language
      • requestContent2TranslationRequestForm

        @NotNull
        public static TranslationRequestFormContent2 requestContent2TranslationRequestForm​(@NotNull
                                                                                           de.espirit.firstspirit.access.store.contentstore.Content2 pTaskTicket,
                                                                                           @NotNull
                                                                                           de.espirit.firstspirit.access.store.contentstore.Content2 pTaskList)
        Create a form result object to translate multiple datasets You can submit a translation request via the get get method to obtain the API interface. Call {@linkplain WorkflowScriptContext(context).requestRegisterOperationFactory().requestRegisterDatasetOperation} to submit your request.
        Parameters:
        pTaskTicket - Content2 of the requests table
        pTaskList - Content2 of the list table
        Returns:
      • requestPageTranslationRequestForm

        @NotNull
        public static TranslationRequestFormPage requestPageTranslationRequestForm​(@NotNull
                                                                                   de.espirit.firstspirit.access.store.contentstore.Content2 pTaskTicket,
                                                                                   @NotNull
                                                                                   de.espirit.firstspirit.access.store.contentstore.Content2 pTaskList)
        Create a form result object to translate a single page with its sections You can submit a translation request via the get get method to obtain the API interface. Call {@linkplain WorkflowScriptContext(context).requestRegisterOperationFactory().requestRegisterPageOperation} to submit your request.
        Parameters:
        pTaskTicket - Content2 of the requests table
        pTaskList - Content2 of the list table
        Returns:
      • requestPageFolderTranslationRequestForm

        @NotNull
        public static TranslationStudioRequestFormPageFolder requestPageFolderTranslationRequestForm​(@NotNull
                                                                                                     de.espirit.firstspirit.access.store.contentstore.Content2 pTaskTicket,
                                                                                                     @NotNull
                                                                                                     de.espirit.firstspirit.access.store.contentstore.Content2 pTaskList)
        Create a form result object to translate a page folder with its pages You can submit a translation request via the get get method to obtain the API interface. Call {@linkplain WorkflowScriptContext(context).requestRegisterOperationFactory().requestRegisterPageFolderOperation} to submit your request.
        Parameters:
        pTaskTicket - Content2 of the requests table
        pTaskList - Content2 of the list table
        Returns:
      • requireTranslationStudioRequestData

        @NotNull
        public static TranslationStudioRequestData requireTranslationStudioRequestData​(boolean bIsPageRequest)
      • install

        @NotNull
        public static void install​(@NotNull
                                   de.espirit.firstspirit.access.GuiScriptContext pContext,
                                   boolean bIsFragment)
        Run installer
        Parameters:
        pContext -
        bIsFragment -