Package de.hybris.platform.jalo.c2l

Class Language

java.lang.Object
de.hybris.platform.util.BridgeAbstraction
de.hybris.platform.jalo.Item
de.hybris.platform.jalo.ExtensibleItem
de.hybris.platform.jalo.c2l.LocalizableItem
de.hybris.platform.jalo.GenericItem
de.hybris.platform.jalo.c2l.GeneratedC2LItem
de.hybris.platform.jalo.c2l.C2LItem
de.hybris.platform.jalo.c2l.GeneratedLanguage
de.hybris.platform.jalo.c2l.Language
All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
MyTestLanguage
public class Language extends GeneratedLanguage
The platform language item.

As the basis of localization in the hybris Platform, they are used for example by localized attributes and links.

Some examples for the use the language items:

  • Each session to the hybris Platform defines in its SessionContext the current session language ( SessionContext.getLanguage()). All localized attributes for example will by default return their value for the session language. Therefore it is very easy to realize multilingual frontends, since you only have to set once the correct session language of get the correct localized values.
  • Localized attributes are internally implemented as MapTypes by mapping languages to their values (language -> localized value). A localized String therefore is realized as a MapType which maps languages to strings.
See Also:

  • Field Details

  • Constructor Details

    • Language

      public Language()

  • Method Details

    • registerAsJaloObject

      @Deprecated(since="ages", forRemoval=false) public static void registerAsJaloObject()
      Deprecated.
      since ages - this is done automatically during initialization of the hybris Platform implementation
      Method registerAsJaloObject

    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      Description copied from class: Item
      Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

      In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
      Sn example: 

      
 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
      Overrides:
      createItem in class GenericItem
      Parameters:
      ctx - the current session context which this item is created within
      type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
      Returns:
      the new item instance
      Throws:
      JaloBusinessException - indicates an error during creation - any changes will be rollbacked

    • getLocale

      public Locale getLocale()
      Returns the corresponding Locale instance according to the isocode of this Language . Therefore the isocode must match the following pattern:
      • Pattern: LANGUAGE-CODE('.'COUNTRY-CODE('.'VARIANT-CHARS))
      • Example: de.DE, en, es.ES.Traditional_WIN
      Returns:
      the corresponding Locale instance according to the isocode of this Language
      See Also:

    • setFallbackLanguages

      public void setFallbackLanguages(SessionContext ctx, List<Language> fallBackTo)
      Description copied from class: GeneratedLanguage
      Generated method - Setter of the Language.fallbackLanguages attribute.
      Specified by:
      setFallbackLanguages in class GeneratedLanguage
      fallBackTo - the fallbackLanguages

    • setFallbackLanguages

      public void setFallbackLanguages(Language... fallBackTo) throws JaloInvalidParameterException
      Throws:
      JaloInvalidParameterException
      Since:
      3.0 M3

    • getFallbackLanguages

      public List<Language> getFallbackLanguages(SessionContext ctx)
      Description copied from class: GeneratedLanguage
      Generated method - Getter of the Language.fallbackLanguages attribute.
      Specified by:
      getFallbackLanguages in class GeneratedLanguage
      Returns:
      the fallbackLanguages

    • remove

      public void remove(SessionContext ctx) throws ConsistencyCheckException
      Removes this Language. If this language is the current session language ( JaloSession.getSessionContext(), SessionContext.getLanguage()), an ConsistencyCheckException is thrown.
      Overrides:
      remove in class Item
      Parameters:
      ctx - A SessionContext object
      Throws:
      ConsistencyCheckException - if the language which should be removed is the current session language
      See Also: