Interface IProjectTranslation

All Known Implementing Classes:
ProjectTranslation

public interface IProjectTranslation
A translation stored in the context of a specified project.

This interface provides all necessary data to describe a translation of any feature.

The contract of some services that use this interface assumes that the IProjectTranslation instances are immutable. So be careful when using your own implementation of class for this interface in cases when it's necessary. Otherwise it's recommended to use the following standard immutable implementation: ProjectTranslation.

See Also:
  • Method Details

    • getLanguage

      String getLanguage()
      Returns the code of language for which the source value was translated.

      Note that IProjectTranslation interface doesn't provides to get the code of source language because of every translating project can have only one default language (see ITranslateProject.getDefaultLanguage()).

      Returns:
      the code of language to translate
    • getStorageId

      String getStorageId()
      Returns the unique identifier of the storage that contains this translation.

      It's assumed that this method should returns the same value as StorageID.toString().

      Returns:
      the unique identifier of the storage that contains this translation
    • getResourceId

      String getResourceId()
      Returns the unique identifier of resource that contains the source value of this translation.
      Returns:
      the identifier of resource that contains the source value
      See Also:
    • getFeatureKey

      String getFeatureKey()
      Returns the feature key.
      Returns:
      the feature key
      See Also:
    • getFeatureName

      String getFeatureName()
      Returns the feature name.
      Returns:
      the feature name.
      See Also:
    • getValue

      String getValue()
      Returns the value to translate.
      Returns:
      returns the value to translate
      See Also:
    • getContext

      Context getContext()
      Returns the type of translating feature.
      Returns:
      the type of translating feature
    • getProjectName

      String getProjectName()
      Returns the name of project that contains translating feature.
      Returns:
      the name of project that contains translating feature
      See Also:
      • IResource.getName()
    • getTranslation

      String getTranslation()
      Returns the translation of the source feature value.
      Returns:
      the translation of the source feature value