Interface ITranslationProvider

Represents a multi-lingual translation engine. This can for instance be a translation memory or machine translation engine.

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi

Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Syntax

public interface ITranslationProvider

Properties

IsReadOnly

Gets a flag which indicates whether the translation provider or its underlying storage are read-only. If this flag is true, no data can be deleted, updated, or added.

Declaration

bool IsReadOnly { get; }

Property Value

Type	Description
bool

Name

Gets the user-friendly name of this provider. It is not necessarily unique across the system.

Declaration

string Name { get; }

Property Value

Type	Description
string

StatusInfo

Gets the status info for the provider.

Declaration

ProviderStatusInfo StatusInfo { get; }

Property Value

Type	Description
ProviderStatusInfo

SupportsConcordanceSearch

Gets a flag which indicates whether the translation provider supports concordance search in the source or the target language. For more detailed information, see SupportsSourceConcordanceSearch and SupportsTargetConcordanceSearch.

Declaration

bool SupportsConcordanceSearch { get; }

Property Value

Type	Description
bool

SupportsSearchForTranslationUnits

Gets a flag which indicates whether the translation provider supports searching for bilingual input TUs (i.e. the SearchTranslationUnit method group). If false, the service only supports searching for simple (monolingual) segments.

Declaration

bool SupportsSearchForTranslationUnits { get; }

Property Value

Type	Description
bool

SupportsSourceConcordanceSearch

Gets a flag which indicates whether the translation provider supports concordance search in the source language.

Declaration

bool SupportsSourceConcordanceSearch { get; }

Property Value

Type	Description
bool

SupportsTargetConcordanceSearch

Gets a flag which indicates whether the translation provider supports concordance search in the target language.

Declaration

bool SupportsTargetConcordanceSearch { get; }

Property Value

Type	Description
bool

SupportsUpdate

Gets a flag which indicates whether the translation provider supports updating/adding of translation units. If false, all update/add methods will return without effect. Note that implementations should not throw exceptions for unsupported methods.

Declaration

bool SupportsUpdate { get; }

Property Value

Type	Description
bool

TranslationMethod

Gets the primary method how the translation provider generates translations.

Declaration

TranslationMethod TranslationMethod { get; }

Property Value

Type	Description
TranslationMethod

Uri

Gets a URI which uniquely identifies this translation provider.

Declaration

Uri Uri { get; }

Property Value

Type	Description
Uri

Methods

GetLanguageDirection(LanguagePair)

Gets a translation provider for the specified language direction.

Declaration

ITranslationProviderLanguageDirection GetLanguageDirection(LanguagePair languageDirection)

Parameters

Type	Name	Description
LanguagePair	languageDirection	The language direction.

Returns

Type	Description
ITranslationProviderLanguageDirection	The language direction matching the given source and target language.

LoadState(string)

Loads previously serialized state information into this translation provider instance.

Declaration

void LoadState(string translationProviderState)

Parameters

Type	Name	Description
string	translationProviderState	A string representing the state of translation provider that was previously saved using SerializeState().

Remarks

The format of this string can be decided upon by the translation provider implementation.

RefreshStatusInfo()

Ensures that the provider's status information (StatusInfo) is refreshed, in case it is cached.

Declaration

void RefreshStatusInfo()

SerializeState()

Serializes any meaningful state information for this translation provider that can be stored in projects and sent around the supply chain.

Declaration

string SerializeState()

Returns

Type	Description
string	A string representing the state of this translation provider that can later be passed into the LoadState(string) method to restore the state after creating a new translation provider.

Remarks

The format of this string can be decided upon by the translation provider implementation.

SupportsLanguageDirection(LanguagePair)

Checks whether this translation provider supports the specified language direction.

Declaration

bool SupportsLanguageDirection(LanguagePair languageDirection)

Parameters

Type	Name	Description
LanguagePair	languageDirection	The language direction.

Returns

Type	Description
bool	True if the specified language direction is supported.