lumis.portal.localization

Interface ILocalizationManager

All Known Implementing Classes:

LocalizationManager

@StableMinor(version="12.2",
             sinceVersion="4.2")
public interface ILocalizationManager

Manager responsible for string localization and locales

Since:

4.0.0

Version:

$Revision: 23534 $ $Date: 2020-01-14 16:16:30 +0000 (Tue, 14 Jan 2020) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	DO_NOT_RENDER_PARAMETERS

Method Summary

Modifier and Type	Method and Description
void	add(LocaleConfig locale) Adds the given locale.
String	addCustomString(SessionConfig sessionConfig, CustomStringConfig customStringConfig, ITransaction transaction) Add a Custom String
void	clearCache() Clear the localization cache.
void	clearCache(String resourcePath) Clear the localization cache by passing the resource path.
void	clearCache(String resourcePath, Locale locale) Clear the localization cache by passing the resource path and the locale.
void	delete(String id) Deletes the locale with the given identifier.
void	deleteCustomString(SessionConfig sessionConfig, String customStringId, ITransaction transaction) Delete a specified Custom String
Iterable<String>	getCachedResourcePaths() Deprecated. Since 8.1.0, this method is no longer available and always returns an empty iterable.
CustomStringConfig	getCustomString(SessionConfig sessionConfig, String customStringId, ITransaction transaction) Get the Custom String object
Locale	getDefaultLocale() Returns the portal default locale.
Collection<Locale>	getLocales() Returns all locales currently available in the portal.
Collection<LocaleConfig>	getLocales(ITransaction transaction) Returns the available locales for the portal.
String	localize(String id, IResource resource) Localizes the given string id using the given resource and current locale.
String	localize(String id, IResource resource, Locale locale) Localizes the given string id using the given resource and locale.
String	localize(String id, IResource resource, Locale locale, WebResource webResource) Localizes the given string id using the given resource, WebResource and locale.
String	localize(String id, IResource resource, PageWebResource pageWebResource) Localizes the given string id using the given resource, PageWebResource and current locale.
String	localize(String id, List<IResource> resources) Localizes the given string id using the given resources and current locale.
String	localize(String id, List<IResource> resources, Locale locale) Localizes the given string id using the given resources and locale.
String	localize(String id, List<IResource> resources, Locale locale, WebResource pageWebResource) Localizes the given string id using the given resources, WebResource and locale.
String	localize(String id, List<IResource> resources, PageWebResource pageWebResource) Localizes the given string id using the given resources, PageWebResource and current locale.
void	update(LocaleConfig locale) Updates the given locale.
void	updateCustomString(SessionConfig sessionConfig, CustomStringConfig customStringConfig, ITransaction transaction) Update a specified Custom String

Field Detail

DO_NOT_RENDER_PARAMETERS

static final String DO_NOT_RENDER_PARAMETERS

See Also:

Constant Field Values

Method Detail

getLocales

Collection<LocaleConfig> getLocales(ITransaction transaction)
                             throws PortalException

Returns the available locales for the portal.

Parameters:

transaction - the transaction for persistence access.

Returns:

A collection with the available locales.

Throws:

PortalException

Since:

4.0.10

getLocales

Collection<Locale> getLocales()

Returns all locales currently available in the portal.

Returns:

locales available in the portal.

Since:

8.1.0

getDefaultLocale

Locale getDefaultLocale()

Returns the portal default locale. The global portal default locale is assumed to be the default locale of the portal root channel.

Returns:

the portal default locale.

Since:

8.1.0

add

void add(LocaleConfig locale)
  throws PortalException

Adds the given locale.

Parameters:

locale - the locale to be added.

Throws:

PortalException

Since:

8.1.0

delete

void delete(String id)
     throws PortalException

Deletes the locale with the given identifier.

Parameters:

id - the locale identifier.

Throws:

PortalException

Since:

8.1.0

update

void update(LocaleConfig locale)
     throws PortalException

Updates the given locale.

Parameters:

locale - the locale to be updated.

Throws:

PortalException

Since:

8.1.0

localize

String localize(String id,
                IResource resource)
         throws PortalException

Localizes the given string id using the given resource and current locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

To take into account localizations from themes, use localize(String, IResource, PageWebResource).

Parameters:

id - The string id to localize

resource - The resource to search for localizations

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

localize

String localize(String id,
                IResource resource,
                PageWebResource pageWebResource)
         throws PortalException

Localizes the given string id using the given resource, PageWebResource and current locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

Parameters:

id - The string id to localize

resource - The resource to search for localizations

pageWebResource - The PageWebResource used to search for localizations within themes.

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

localize

String localize(String id,
                List<IResource> resources)
         throws PortalException

Localizes the given string id using the given resources and current locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

To take into account localizations from themes, use localize(String, List, PageWebResource).

Parameters:

id - The string id to localize

resources - The resources to search for localizations

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

localize

String localize(String id,
                List<IResource> resources,
                PageWebResource pageWebResource)
         throws PortalException

Localizes the given string id using the given resources, PageWebResource and current locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

Parameters:

id - The string id to localize

resources - The resources to search for localizations

pageWebResource - The PageWebResource used to search for localizations within themes.

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

localize

String localize(String id,
                IResource resource,
                Locale locale)
         throws PortalException

Localizes the given string id using the given resource and locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

To take into account localizations from themes, use #localize(String, IResource, Locale, PageWebResource) .

Parameters:

id - The string id to localize

resource - The resource to search for localizations

locale - The locale to use for localization

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

localize

String localize(String id,
                IResource resource,
                Locale locale,
                WebResource webResource)
         throws PortalException

Localizes the given string id using the given resource, WebResource and locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

Parameters:

id - The string id to localize

resource - The resources to search for localizations

locale - The locale to use for localization

webResource - The WebResource used to search for localizations within themes.

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

localize

String localize(String id,
                List<IResource> resources,
                Locale locale)
         throws PortalException

Localizes the given string id using the given resources and locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

To take into account localizations from themes, use #localize(String, List, Locale, PageWebResource).

Parameters:

id - The string id to localize

resources - The resources to search for localizations

locale - The locale to use for localization

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

localize

String localize(String id,
                List<IResource> resources,
                Locale locale,
                WebResource pageWebResource)
         throws PortalException

Localizes the given string id using the given resources, WebResource and locale.

If no localized value is found for the given id, the id itself is returned.
If the string id passed in is null, the return value will also be null.

Parameters:

id - The string id to localize

resources - The resources to search for localizations

locale - The locale to use for localization

webResource - The WebResource used to search for localizations within themes.

Returns:

The localized string
Or the received string id when no localization was found. If the passed id is null, null is also returned.

Throws:

PortalException

clearCache

void clearCache()
         throws PortalException

Clear the localization cache.

Throws:

PortalException

clearCache

void clearCache(String resourcePath)
         throws PortalException

Clear the localization cache by passing the resource path.

Parameters:

resourcePath -

Throws:

PortalException

clearCache

void clearCache(String resourcePath,
                Locale locale)
         throws PortalException

Clear the localization cache by passing the resource path and the locale.

Parameters:

resourcePath -

locale -

Throws:

PortalException

getCachedResourcePaths

@Deprecated
Iterable<String> getCachedResourcePaths()
                                             throws ManagerException

Deprecated. Since 8.1.0, this method is no longer available and always returns an empty iterable.

Get the keys for all cached items

Returns:

Throws:

ManagerException

addCustomString

String addCustomString(SessionConfig sessionConfig,
                       CustomStringConfig customStringConfig,
                       ITransaction transaction)
                throws PortalException

Add a Custom String

Parameters:

sessionConfig -

customStringConfig -

transaction -

Returns:

Throws:

PortalException

updateCustomString

void updateCustomString(SessionConfig sessionConfig,
                        CustomStringConfig customStringConfig,
                        ITransaction transaction)
                 throws PortalException

Update a specified Custom String

Parameters:

sessionConfig -

customStringConfig -

transaction -

Throws:

PortalException

deleteCustomString

void deleteCustomString(SessionConfig sessionConfig,
                        String customStringId,
                        ITransaction transaction)
                 throws PortalException

Delete a specified Custom String

Parameters:

sessionConfig -

customStringId -

transaction -

Throws:

PortalException

getCustomString

CustomStringConfig getCustomString(SessionConfig sessionConfig,
                                   String customStringId,
                                   ITransaction transaction)
                            throws PortalException

Get the Custom String object

Parameters:

sessionConfig -

customStringId -

transaction -

Returns:

Throws:

PortalException