# com.bea.netuix.application.localization.manager
ILocalizationManager Interface

public interface ILocalizationManager

This is the primary interface for performing persistent store operations on localizations.

All Known Subinterfaces
  `LocalizationManager`

## Method Summary

`public `LocalizationResource`` | `addLocalizationResource`(`LocalizationResource` localizationResource, `LocalizationIntersectionId` localizationIntersectionId) Add a new localization resource (l10n label) to the definition.
`public `LocalizationLocale`` | `createLocalizationLocale`(`LocalizationLocale` localizationLocale)
`public `LocalizationResource`` | `createLocalizationResource`(`LocalizationResource` localizationResource) Create a new localization resource (l10n label) from the supplied resource.
`public void` | `deleteLocalizationLocale`(`LocalizationLocaleId` localizationLocaleId) Delete a LocalizationLocale record and all LocalizationResources associated to this locale.
`public void` | `deleteLocalizationResource`(`LocalizationLocaleId` localizationLocaleId, `LocalizationIntersectionId` localizationIntersectionId) Delete a single localization definition record (table effected L10N_RESOURCE).
`public `LocalizationLocale`` | `getLocalizationLocale`(`Locale` locale)
`public `LocalizationLocale`` | `getLocalizationLocale`(`LocalizationLocaleId` localizationLocaleId)
`public `LocalizationLocale`[]` | `getLocalizationLocales`() Return an array of all the available locales in the system.
`public `LocalizationResource`` | `getLocalizationResource`(`CustomizationContext` customizationContext, `LocalizationIntersectionId` localizationIntersectionId) A single localization resource given the specified localization intersection id and the customization context.
`public `LocalizationResource`[]` | `getLocalizationResources`(`LocalizationIntersectionId` localizationIntersectionId) Retrieve an array of LocalizationResourceView definitions for the specified abstract `LocalizationIntersectionId`.
`public `LocalizationResource`[]` | `getLocalizationResources`() Retrurn a list of all the localization resources in the system
`public `LocalizationResourceView`` | `getLocalizationResourceView`(`CustomizationContext` customizationContext, `LocalizationIntersectionId` localizationIntersectionId) Retrieve an array of LocalizationResourceView for the supplied `LocalizationIntersectionId`.
`public `Locale`[]` | `getMatchingSupportedLocales`(`Locale`[] locales) Used to get a minimal set of Locales based on the input array of Locales that matches supported Locales.
`public void` | `updateLocalizationLocale`(`LocalizationLocale` localizationLocale)
`public void` | `updateLocalizationResource`(`LocalizationResource` localizationResource) Update the localization definition with the new data.

## Method Detail

### addLocalizationResource(LocalizationResource, LocalizationIntersectionId) Method

    public LocalizationResource addLocalizationResource(LocalizationResource localizationResource,
                                                        LocalizationIntersectionId localizationIntersectionId)
         throws RemoteException, ObjectNotFoundException, MissingDataException

Add a new localization resource (l10n label) to the definition.

#### Parameters

localizationResource
  the object containing all the new data for the new localization.

localizationIntersectionId
  intersection id from the Defintiion object.

#### Returns

a fully populated (with LocalizationIntersectionId and LocalizationLocaleId) LocalizationResource.

#### Exceptions

``RemoteException``
``ObjectNotFoundException``
``MissingDataException``

### createLocalizationLocale(LocalizationLocale) Method

    public LocalizationLocale createLocalizationLocale(LocalizationLocale localizationLocale)
         throws RemoteException, MissingDataException

#### Exceptions

``RemoteException``
``MissingDataException``

### createLocalizationResource(LocalizationResource) Method

    public LocalizationResource createLocalizationResource(LocalizationResource localizationResource)
         throws RemoteException, ObjectNotFoundException, MissingDataException

Create a new localization resource (l10n label) from the supplied resource.

#### Parameters

localizationResource
  the object containing all the new data for the new localization.

#### Returns

a fully populated (with LocalizationIntersectionId and LocalizationLocaleId) LocalizationResource.

#### Exceptions

``RemoteException``
``ObjectNotFoundException``
``MissingDataException``

### deleteLocalizationLocale(LocalizationLocaleId) Method

    public void deleteLocalizationLocale(LocalizationLocaleId localizationLocaleId)
         throws RemoteException, ObjectNotFoundException

Delete a LocalizationLocale record and all LocalizationResources associated to this locale. Table effected (L10N_LOCALE, L10N_RESOURCE)

#### Exceptions

``RemoteException``
``ObjectNotFoundException``

### deleteLocalizationResource(LocalizationLocaleId, LocalizationIntersectionId) Method

    public void deleteLocalizationResource(LocalizationLocaleId localizationLocaleId,
                                           LocalizationIntersectionId localizationIntersectionId)
         throws RemoteException, ObjectNotFoundException

Delete a single localization definition record (table effected L10N_RESOURCE). Note, this method does not delete any records in the L10N_INTERSECTION table, as this would cause the definition record to be deleted as well.

#### Parameters

localizationLocaleId
  the first part of the primary key

localizationIntersectionId
  the second part of the primary key of the localization resord to delete.

#### Exceptions

``RemoteException``
``ObjectNotFoundException``

### getLocalizationLocale(Locale) Method

    public LocalizationLocale getLocalizationLocale(Locale locale)
         throws RemoteException

#### Exceptions

``RemoteException``

### getLocalizationLocale(LocalizationLocaleId) Method

    public LocalizationLocale getLocalizationLocale(LocalizationLocaleId localizationLocaleId)
         throws RemoteException

#### Exceptions

``RemoteException``

### getLocalizationLocales() Method

    public LocalizationLocale[] getLocalizationLocales()
         throws RemoteException

Return an array of all the available locales in the system.

#### Returns

an array of distinct LocaleDefintoin objects.

#### Exceptions

``RemoteException``

### getLocalizationResource(CustomizationContext, LocalizationIntersectionId) Method

    public LocalizationResource getLocalizationResource(CustomizationContext customizationContext,
                                                        LocalizationIntersectionId localizationIntersectionId)
         throws RemoteException

A single localization resource given the specified localization intersection id and the customization context.

#### Parameters

customizationContext
  contains the prefered locale.

localizationIntersectionId
  the unique id of the definition object.

#### Returns

a fully populated LocalizationResource object.

#### Exceptions

``RemoteException``

### getLocalizationResources(LocalizationIntersectionId) Method

    public LocalizationResource[] getLocalizationResources(LocalizationIntersectionId localizationIntersectionId)
         throws RemoteException

Retrieve an array of LocalizationResourceView definitions for the specified abstract `LocalizationIntersectionId`.

#### Parameters

localizationIntersectionId
  a unique identifier for any definition object. Example: PortletDefinitionId, ShellDefinitionId, ...

#### Returns

an Array of all the different localization definitions (one for each different locale) set for the specified definition id.

#### Exceptions

``RemoteException``

### getLocalizationResources() Method

    public LocalizationResource[] getLocalizationResources()
         throws RemoteException

Retrurn a list of all the localization resources in the system

#### Exceptions

``RemoteException``

### getLocalizationResourceView(CustomizationContext, LocalizationIntersectionId) Method

    public LocalizationResourceView getLocalizationResourceView(CustomizationContext customizationContext,
                                                                LocalizationIntersectionId localizationIntersectionId)
         throws RemoteException

Retrieve an array of LocalizationResourceView for the supplied `LocalizationIntersectionId`.

#### Parameters

customizationContext
  contains an in order list of predered locales.

localizationIntersectionId
  a unique identifier for any definition object. Example: PortletDefinitionId, ShellDefinitionId, ...

#### Returns

an immutabel LocalizationResourceView object internationalized to the supplied locale. If the prefered locale does not exist we will default to the default, if no localization exist we will return null.

#### Exceptions

``RemoteException``

### getMatchingSupportedLocales(Locale[]) Method

    public Locale[] getMatchingSupportedLocales(Locale[] locales)
         throws RemoteException

Used to get a minimal set of Locales based on the input array of Locales that matches supported Locales.

#### Returns

minimal set of supported Locales based on input Locales

#### Exceptions

``RemoteException``

### updateLocalizationLocale(LocalizationLocale) Method

    public void updateLocalizationLocale(LocalizationLocale localizationLocale)
         throws RemoteException, ObjectNotFoundException

#### Exceptions

``RemoteException``
``ObjectNotFoundException``

### updateLocalizationResource(LocalizationResource) Method

    public void updateLocalizationResource(LocalizationResource localizationResource)
         throws RemoteException, ObjectNotFoundException

Update the localization definition with the new data.

#### Parameters

localizationResource
  the localizationdefinition containing the new data

#### Exceptions

``RemoteException``
``ObjectNotFoundException``