Package org.odpi.openmetadata.commonservices.gaf.api

Interface MultiLanguageInterface

All Known Implementing Classes:

GovernanceEngineClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClientBase

public interface MultiLanguageInterface

MultiLanguageInterface enables translations of the string properties of a metadata element to be created, maintained and retrieved.

Method Summary

Modifier and Type	Method	Description
void	clearTranslation(java.lang.String userId, java.lang.String elementGUID, java.lang.String language, java.lang.String locale)	Remove the translation for a particular language/locale for a metadata element.
TranslationDetail	getTranslation(java.lang.String userId, java.lang.String elementGUID, java.lang.String language, java.lang.String locale)	Retrieve the translation for the matching language/locale.
java.util.List<TranslationDetail>	getTranslations(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)	Retrieve all translations associated with a metadata element.
void	setTranslation(java.lang.String userId, java.lang.String elementGUID, TranslationDetail translationDetail)	Create or update the translation for a particular language/locale for a metadata element.

Method Detail

setTranslation

void setTranslation(java.lang.String userId,
                    java.lang.String elementGUID,
                    TranslationDetail translationDetail)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    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:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

clearTranslation

void clearTranslation(java.lang.String userId,
                      java.lang.String elementGUID,
                      java.lang.String language,
                      java.lang.String locale)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      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:

InvalidParameterException - the language is null or not known or not unique (add locale)

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getTranslation

TranslationDetail getTranslation(java.lang.String userId,
                                 java.lang.String elementGUID,
                                 java.lang.String language,
                                 java.lang.String locale)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 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:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getTranslations

java.util.List<TranslationDetail> getTranslations(java.lang.String userId,
                                                  java.lang.String elementGUID,
                                                  int startFrom,
                                                  int pageSize)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  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:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store