Package org.odpi.openmetadata.frameworks.governanceaction.client

Interface MultiLanguageInterface

All Known Implementing Classes:
OpenMetadataClient
public interface MultiLanguageInterface
MultiLanguageInterface enables translations of the string properties of a metadata element to be created, maintained and retrieved.

  • Method Details

    • setTranslation

      void setTranslation(String userId, String elementGUID, TranslationDetail translationDetail) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create or update the translation for a particular language/locale for a metadata element.
      Parameters:
      userId - caller's userId
      elementGUID - unique identifier of the element that this translation is related to
      translationDetail - properties of the translation
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null or not known.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the service is not able to access the element
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

    • clearTranslation

      void clearTranslation(String userId, String elementGUID, String language, String locale) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the translation for a particular language/locale for a metadata element.
      Parameters:
      userId - caller's userId
      elementGUID - unique identifier of the element that this translation is related to
      language - language requested
      locale - optional locale to qualify which translation if there are multiple translations for the language.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the language is null or not known or not unique (add locale)
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the service is not able to access the element
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

    • getTranslation

      TranslationDetail getTranslation(String userId, String elementGUID, String language, String locale) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the translation for the matching language/locale.
      Parameters:
      userId - caller's userId
      elementGUID - unique identifier of the element that this translation is related to
      language - language requested
      locale - optional locale to qualify which translation if there are multiple translations for the language.
      Returns:
      the properties of the translation or null if there is none
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null or not known.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the service is not able to access the element
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

    • getTranslations

      List<TranslationDetail> getTranslations(String userId, String elementGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve all translations associated with a metadata element.
      Parameters:
      userId - caller's userId
      elementGUID - unique identifier of the element that this translation is related to
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      Returns:
      list of translation properties or null if there are none
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null or not known.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the service is not able to access the element
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store