Interface IScopedTranslationProvider.IScopedTranslationResult

All Superinterfaces:
IHistoryTranslationProvider.ITranslationResult, IPageIterable<IPage<IProjectTranslation>>, Iterable<IPage<IProjectTranslation>>
Enclosing interface:
IScopedTranslationProvider

public static interface IScopedTranslationProvider.IScopedTranslationResult extends IHistoryTranslationProvider.ITranslationResult
The result of translation that contains all translations are grouped by translated value and filtered by specified scope.

In addition to IHistoryTranslationProvider.ITranslationResult this interface contains the method returns the scope name by which translations have been filtered.

See Also:
  • Method Details

    • getScopeId

      String getScopeId()
      Returns the unique id of the scope by which found translations have been filtered.

      The returned scope name must be associated with the IQueryScope which can be fetched in the following way:

       IScopedTranslationResutl result = ...;
       
       IQueryScopeService scopeService = ...;
       IQueryScope scope = scopeService.find(result.getScopeId()).orElseThrow(// throw some exception here );
       

      Returns:
      the scope id (can't be null)