com.sapportals.admin.wizardframework.util

Interface ILocaleListService

All Superinterfaces:
ILocalesConfigService, IService

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public interface ILocaleListService
extends IService, ILocalesConfigService

The service that gets a list of valid languages allowed as the master language for an object(source locales), and a list of target languages for translation. Enables manipulations on the valid languages.


Field Summary
static String KEY
          Deprecated. The service key.
 
Method Summary
 Locale getClosestAvailableLocale(Locale requestedLocale)
          Deprecated. use ILocalesConfigService.getClosestAvailableSourceLocale(java.util.Locale)
 List getDisplayNamesForLocales(List localeList, Locale displayLocale)
          Deprecated. Gets a list of the locale names to be displayed to the user for a specified list of locales.
 List getListOfCustomizedLocalesOrderedByDisplayName(Locale displayLocale)
          Deprecated. Returns a list of customized locales sorted by the display name.
 List getListOfLocalesOrderedByDisplayName(Locale displayLocale)
          Deprecated. use ILocalesConfigService.getListOfSourceLocalesOrderedByDisplayName(java.util.Locale)
 List getListOfPersLocalesOrderedByDisplayName(Locale displayLocale)
          Deprecated. Gets a list of personalization locales that are sorted by the display name.
 String getLocaleDisplayName(Locale localeToDisplay, Locale localeToDisplayIn)
          Deprecated. Gets the locale name to be displayed to the user.
 Locale getLocaleForTechnicalName(String localeTechnicalName)
          Deprecated. Gets the locale for a specified locale technical name.
 String getLocaleTechnicalName(Locale loc)
          Deprecated. Gets the locale technical name for a specified locale.
 List getTechnicalNamesForLocales(List localeList)
          Deprecated. Gets the technical names for a specified list of locales.
 
Methods inherited from interface com.sapportals.admin.wizardframework.util.ILocalesConfigService
getClosestAvailablePersLocale, getClosestAvailableSourceLocale, getClosestAvailableTargetLocale, getListOfSourceLocalesOrderedByDisplayName, getListOfTargetLocalesOrderedByDisplayName
 
Methods inherited from interface com.sapportals.portal.prt.service.IService
afterInit, configure, destroy, getContext, getKey, init, release
 

Field Detail

KEY

static final String KEY
Deprecated. 
The service key.

See Also:
Constant Field Values
Method Detail

getListOfPersLocalesOrderedByDisplayName

List getListOfPersLocalesOrderedByDisplayName(Locale displayLocale)
Deprecated. 
Gets a list of personalization locales that are sorted by the display name.

Specified by:
getListOfPersLocalesOrderedByDisplayName in interface ILocalesConfigService
Parameters:
displayLocale - a locale display name
Returns:
a sorted list of personalization locales

getListOfLocalesOrderedByDisplayName

List getListOfLocalesOrderedByDisplayName(Locale displayLocale)
Deprecated. use ILocalesConfigService.getListOfSourceLocalesOrderedByDisplayName(java.util.Locale)

Gets a list of locales that are sorted by the display name.

Parameters:
displayLocale - a locale display name
Returns:
an ordered list of locales

getLocaleDisplayName

String getLocaleDisplayName(Locale localeToDisplay,
                            Locale localeToDisplayIn)
Deprecated. 
Gets the locale name to be displayed to the user. For example, English (United States).

Parameters:
localeToDisplay - the current locale
localeToDisplayIn - the language
Returns:
the locale display name

getLocaleTechnicalName

String getLocaleTechnicalName(Locale loc)
Deprecated. 
Gets the locale technical name for a specified locale.

Parameters:
loc - a locale
Returns:
the locale technical name

getDisplayNamesForLocales

List getDisplayNamesForLocales(List localeList,
                               Locale displayLocale)
Deprecated. 
Gets a list of the locale names to be displayed to the user for a specified list of locales.

Parameters:
localeList - a list of locales
displayLocale - a locale display name
Returns:
a list of display names

getTechnicalNamesForLocales

List getTechnicalNamesForLocales(List localeList)
Deprecated. 
Gets the technical names for a specified list of locales.

Parameters:
localeList - a list of locales
Returns:
a list of technical names

getLocaleForTechnicalName

Locale getLocaleForTechnicalName(String localeTechnicalName)
Deprecated. 
Gets the locale for a specified locale technical name.

Parameters:
localeTechnicalName - a locale technical name
Returns:
the locale

getClosestAvailableLocale

Locale getClosestAvailableLocale(Locale requestedLocale)
Deprecated. use ILocalesConfigService.getClosestAvailableSourceLocale(java.util.Locale)

Gets the closest available locale for a specified locale.

Parameters:
requestedLocale - a locale
Returns:
the closest available locale

getListOfCustomizedLocalesOrderedByDisplayName

List getListOfCustomizedLocalesOrderedByDisplayName(Locale displayLocale)
Deprecated. 
Returns a list of customized locales sorted by the display name. The list is empty by default, and contains values if it is customized by an administrator. This list is used by the wizard frameworks for displaying the list of locales. If the customized list of locales is empty, the wizards display the locales retrieved by the getListOfLocalesOrderedByDisplayName(java.util.Locale) method.

Parameters:
displayLocale - a locale display name
Returns:
a sorted list of the customized locales
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] com.sap.portal.admin.wizardframeworkdeprecated api EP-PIN-APF
[sap.com] EP-RUNTIME [sap.com] tc/ep/admin/api api EP-PIN
[sap.com] EP-RUNTIME [sap.com] com.sap.portal.admin.wizardframeworkdeprecated - EP-PIN-APF


Copyright 2011 SAP AG Complete Copyright Notice