Package com.idmedia.translationstudio.api.firstspirit

Interface ITranslationRequestFormSpecific

All Known Subinterfaces:

ITranslationRequestFormSpecificFull

public interface ITranslationRequestFormSpecific

Author:

Phillip Austerfield

Method Summary

Modifier and Type	Method	Description
void	addCustomInformation(String sFieldName, String sValue)	Add a custom information attribute
void	addTranslatableEntity(de.espirit.firstspirit.access.store.contentstore.Content2 pContent2, de.espirit.firstspirit.access.store.contentstore.Dataset pDataset, de.espirit.firstspirit.access.store.contentstore.Dataset pDatasetTarget, String sDisplayName)	Add a dataset to be translated and assign target dataset to receive the translated content.
void	addTranslatableEntity(de.espirit.firstspirit.access.store.contentstore.Content2 pContent2, de.espirit.firstspirit.access.store.contentstore.Dataset pDataset, String sDisplayName)	Add a Dataset to be translated
void	addTranslatablePage(de.espirit.firstspirit.access.store.globalstore.GCAPage pPage, de.espirit.firstspirit.access.store.IDProvider pElement, String sDisplayName)	Add a GCA page/section to be translated
void	addTranslatablePage(de.espirit.firstspirit.access.store.pagestore.Page pPage, de.espirit.firstspirit.access.store.IDProvider pElement, String sDisplayName)	Add a page/section to be translated
boolean	addTranslationLanguage(de.espirit.firstspirit.access.Language pSourceLanguage, de.espirit.firstspirit.access.Language pTargetLanguage, String sConnectorGuid)	Add a language combination to be translated using a given connector.
boolean	addTranslationLanguage(de.espirit.firstspirit.access.store.globalstore.GCAPage pPage)	Add a language mappings page that holds all relevant information on source/target langauge and connector.
boolean	isEmpty()	Check if given form is empty
void	setDueDate(Date pDate)	Set the due date (optionally)
void	setTranslateImmediately(boolean bImmediately)	Either translate immediately (default) or use quotes.
void	setUserToNotify(long lUserId)	Notify given user
boolean	submitTranslation()	Submit files to TranslationStudio

Method Detail

addTranslationLanguage

boolean addTranslationLanguage(@NotNull
                               de.espirit.firstspirit.access.store.globalstore.GCAPage pPage)

Add a language mappings page that holds all relevant information on source/target langauge and connector.

Parameters:

pPage -

Returns:

validation result

addTranslationLanguage

boolean addTranslationLanguage(@NotNull
                               de.espirit.firstspirit.access.Language pSourceLanguage,
                               @NotNull
                               de.espirit.firstspirit.access.Language pTargetLanguage,
                               @NotNull
                               String sConnectorGuid)

Add a language combination to be translated using a given connector.

Parameters:

pSourceLanguage - Source Language

pTargetLanguage - Target Language

sConnectorGuid - Connector Guid

Returns:

validation result

addTranslatablePage

void addTranslatablePage(@NotNull
                         de.espirit.firstspirit.access.store.pagestore.Page pPage,
                         @NotNull
                         de.espirit.firstspirit.access.store.IDProvider pElement,
                         @NotNull
                         String sDisplayName)

Add a page/section to be translated

Parameters:

pPage - Page

pElement - Element (Page or Section) to be translated

sDisplayName - Display name of given element (or empty String)

addTranslatablePage

void addTranslatablePage(@NotNull
                         de.espirit.firstspirit.access.store.globalstore.GCAPage pPage,
                         @NotNull
                         de.espirit.firstspirit.access.store.IDProvider pElement,
                         @NotNull
                         String sDisplayName)

Add a GCA page/section to be translated

Parameters:

pPage - Page

pElement - Element (Page or Section) to be translated

sDisplayName - Display name of given element (or empty String)

addTranslatableEntity

void addTranslatableEntity(@NotNull
                           de.espirit.firstspirit.access.store.contentstore.Content2 pContent2,
                           @NotNull
                           de.espirit.firstspirit.access.store.contentstore.Dataset pDataset,
                           @NotNull
                           String sDisplayName)

Add a Dataset to be translated

Parameters:

pContent2 - Content2 Object

pDataset - Dataset

sDisplayName - Display name of given element (or empty String)

addTranslatableEntity

void addTranslatableEntity(@NotNull
                           de.espirit.firstspirit.access.store.contentstore.Content2 pContent2,
                           @NotNull
                           de.espirit.firstspirit.access.store.contentstore.Dataset pDataset,
                           @NotNull
                           de.espirit.firstspirit.access.store.contentstore.Dataset pDatasetTarget,
                           @NotNull
                           String sDisplayName)

Add a dataset to be translated and assign target dataset to receive the translated content. This will only be valid if the source dataset contains 100% language independent fields.

Parameters:

pContent2 - Content2 Object

pDataset - Dataset Source dataset to be translated

pDatasetTarget - Target dataset to receive translated content

sDisplayName - Display name of given element (or empty String)

addCustomInformation

void addCustomInformation(@NotNull
                          String sFieldName,
                          @NotNull
                          String sValue)

Add a custom information attribute

Parameters:

sFieldName - Name

sValue - Value

isEmpty

boolean isEmpty()

Check if given form is empty

Returns:

setUserToNotify

void setUserToNotify(long lUserId)

Notify given user

Parameters:

lUserId -

setDueDate

void setDueDate(@Nullable
                Date pDate)

Set the due date (optionally)

Parameters:

pDate -

setTranslateImmediately

void setTranslateImmediately(boolean bImmediately)

Either translate immediately (default) or use quotes.

Parameters:

bImmediately -

submitTranslation

boolean submitTranslation()
                   throws IOException

Submit files to TranslationStudio

Returns:

Success state

Throws:

IOException - Exception if TranslationStudio could not be reached