Package de.hybris.platform.jalo.c2l

Class C2LManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.c2l.C2LManager

All Implemented Interfaces:

ItemLifecycleListener, Serializable

public class C2LManager
extends Manager

The manager for all items of this package, which offers methods to create and get Items of this package.

• Country
• Currency
• Language
• Region

See Also:

• JaloSession
• Cart
• Order
• Address
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	C2LManager.C2LCacheKey
protected static class	C2LManager.C2LManagerSerializableDTO

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BEAN_NAME

Constructor Summary

Constructors

Constructor	Description
C2LManager()

Method Summary

Modifier and Type	Method	Description
protected void	checkBeforeItemRemoval(SessionContext ctx, Item item)	Deprecated. since ages - useRemoveInterceptor instead.
Country	createCountry(PK pkBase, String isoCode)	Deprecated. since ages - use plainCountryModel creation instead see createCountry(String), see also model saving example
Country	createCountry(String isoCode)	Deprecated. since ages - use plainCountryModel creation instead :
Currency	createCurrency(PK pkBase, String isoCode)	Deprecated. since ages - use plainCurrencyModel creation instead see createCurrency(String) see also model saving example.
Currency	createCurrency(String isoCode)	Deprecated. since ages - use plainCurrencyModel creation instead :
Language	createLanguage(PK pk, String isoCode)	Deprecated. since ages - use plainLanguageModel creation see createLanguage(String) see also model saving example.
Language	createLanguage(String isoCode)	Deprecated. since ages - use plainLanguageModel creation instead :
Region	createRegion(PK pkBase, String code, Country country)	Deprecated. since ages - use plainRegionModel creation instead see also model saving example.
Region	createRegion(String code, Country country)	Deprecated. since ages - please useCountry.addNewRegion(String) instead
Set<Country>	getActiveCountries()	Deprecated. since ages - useCommonI18NService.getAllCountries() instead.
Set<Currency>	getActiveCurrencies()	Deprecated. since ages - useCommonI18NService.getAllCurrencies() instead.
Set<Language>	getActiveLanguages()	Deprecated. since ages - useCommonI18NService.getAllLanguages() instead.
Set<Region>	getActiveRegions()	Deprecated. since ages - useCommonI18NService.getAllRegions() instead.
Set<Country>	getAllCountries()	Deprecated. since ages - useCommonI18NService.getAllCountries() instead.
Set<Currency>	getAllCurrencies()	Deprecated. since ages - useCommonI18NService.getAllCurrencies() instead.
Set<Language>	getAllLanguages()	Deprecated. since ages - useCommonI18NService.getAllLanguages() instead.
Set<Region>	getAllRegions()	Deprecated. since ages - useCommonI18NService.getAllRegions() instead.
Currency	getBaseCurrency()	Deprecated. since ages - useCommonI18NService.getBaseCurrency() instead.
Country	getCountryByIsoCode(String iso)	Deprecated. since ages - useCommonI18NService.getCountry(String) instead.
Currency	getCurrencyByIsoCode(String iso)	Deprecated. since ages - useCommonI18NService.getCurrency(String) instead.
Currency	getDefaultCurrencyForTenant(Tenant t)
Language	getDefaultLanguageForTenant(Tenant t)
static C2LManager	getInstance()
Language	getLanguageByIsoCode(String iso)	Deprecated. since ages - useCommonI18NService.getLanguage(String) instead.
Region	getRegionByCode(Country country, String code)	Deprecated. since ages - use CommonI18NService.getRegion(de.hybris.platform.core.model.c2l.CountryModel, String) instead.
Region	getRegionByCode(String code)	Deprecated. since ages - You should consider not using region data without its country context , in that case use CommonI18NService.getRegion(de.hybris.platform.core.model.c2l.CountryModel, String) instead.
Collection<Region>	getRegions(Country country)	Deprecated. since ages - useCountryModel.getRegions() instead.
Collection<Region>	getRegionsByCode(String code)	Deprecated. since ages - You should consider not using region data without its country context, in that use CommonI18NService.getRegion(de.hybris.platform.core.model.c2l.CountryModel, String) instead.
void	init()	called once for each tenant, so this method fits best to perform some initialization stuff
protected void	notifyItemRemoval(SessionContext ctx, Item item)	TODO improve API doc Is called just before a item is being removed.
void	setBaseCurrency(Currency currency)	Deprecated. since ages - use {Currency#setBase()} instead.
Object	writeReplace()

Methods inherited from class de.hybris.platform.jalo.Manager

afterItemCreation, beforeItemCreation, destroy, extractNonRequiredRemoteFromItem, extractRequiredRemoteFromItem, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemote, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, setAttribute, setTenant, setTransientObject, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BEAN_NAME

public static final String BEAN_NAME

See Also:

• Constant Field Values

Constructor Details

C2LManager

public C2LManager()

Method Details

getInstance

public static C2LManager getInstance()

Returns:

instance of this manager

init

public void init()

Description copied from class: Manager

called once for each tenant, so this method fits best to perform some initialization stuff

Overrides:

init in class Manager

checkBeforeItemRemoval

@Deprecated(since="ages",
            forRemoval=false)
protected void checkBeforeItemRemoval(SessionContext ctx,
 Item item)
                               throws ConsistencyCheckException

Deprecated.

since ages - useRemoveInterceptor instead.

Superclass method overridden to avoid call to EJB layer. Disallows removal of:

• the last active currency,
• the base currency,
• any active language.

Overrides:

checkBeforeItemRemoval in class Manager

Parameters:

ctx - the current session context

item - the item which should be removed

Throws:

ConsistencyCheckException - thrown to abort removal due to consistency errors

Since:

2.10

getLanguageByIsoCode

@Deprecated(since="ages",
            forRemoval=false)
public Language getLanguageByIsoCode(String iso)
                              throws JaloItemNotFoundException

Deprecated.

since ages - useCommonI18NService.getLanguage(String) instead.

Returns the Language with the specified iso code. If there exists no Language with the specified iso code a JaloItemNotFoundException is thrown.

Parameters:

iso - the isocode of the searched Language

Returns:

the Language with the specified isocode

Throws:

JaloItemNotFoundException - if there exists no Language with the specified iso code

createLanguage

@Deprecated(since="ages",
            forRemoval=false)
public Language createLanguage(String isoCode)
                        throws ConsistencyCheckException

Deprecated.

since ages - use plainLanguageModel creation instead :

 
 final LanguageModel lmodel = modelService.create(LanguageModel.class);
 lmodel.setIsocode("tinyRed");
 modelService.save(lmodel);
 
 

see also model saving example.

Creates a new Language with the specified iso code.

Parameters:

isoCode - the iso code of the new Language

Returns:

the Language with the specified iso code

Throws:

ConsistencyCheckException - if there already exists a language with the specified iso code

createLanguage

@Deprecated(since="ages",
            forRemoval=false)
public Language createLanguage(PK pk,
 String isoCode)
                        throws ConsistencyCheckException

Deprecated.

since ages - use plainLanguageModel creation see createLanguage(String) see also model saving example.

Creates a new Language with the specified iso code and pk.

Parameters:

pk - the primary key of the new Language

isoCode - the iso code of the new Language

Returns:

the Language with the specified iso code

Throws:

ConsistencyCheckException - if there already exists a language with the specified iso code

getAllLanguages

@Deprecated(since="ages",
            forRemoval=false)
public Set<Language> getAllLanguages()

Deprecated.

since ages - useCommonI18NService.getAllLanguages() instead.

Returns a Set of all languages.

Returns:

a Set of all languages

getActiveLanguages

@Deprecated(since="ages",
            forRemoval=false)
public Set<Language> getActiveLanguages()

Deprecated.

since ages - useCommonI18NService.getAllLanguages() instead.

Returns a Collection of all active languages (GeneratedC2LItem.isActive() == true ). This is meant to provide a way to select only the languages which are to be shown in applications ( web ) even though a large number of them exists.

Returns:

a Collection of all active languages

getDefaultLanguageForTenant

public Language getDefaultLanguageForTenant(Tenant t)

getDefaultCurrencyForTenant

public Currency getDefaultCurrencyForTenant(Tenant t)

getCurrencyByIsoCode

@Deprecated(since="ages",
            forRemoval=false)
public Currency getCurrencyByIsoCode(String iso)
                              throws JaloItemNotFoundException

Deprecated.

since ages - useCommonI18NService.getCurrency(String) instead.

Returns the Currency with the specified iso code. If there exists no Currency with the specified iso code a JaloItemNotFoundException is thrown.

Parameters:

iso - the iso code of the searched Currency

Returns:

the Currency with the specified iso code

Throws:

JaloItemNotFoundException - if there exists no Currency with the specified iso code

createCurrency

@Deprecated(since="ages",
            forRemoval=false)
public Currency createCurrency(String isoCode)
                        throws ConsistencyCheckException

Deprecated.

since ages - use plainCurrencyModel creation instead :

 
 final CurrencyModel model = modelService.create(CurrencyModel.class);
 model.setIsocode("tinyRed");
 modelService.save(model);
 
 

see also model saving example

Creates a new Currency with the specified iso code.

Parameters:

isoCode - the iso code of the new Currency

Returns:

the new Currency

Throws:

ConsistencyCheckException - if there already exists a Currency with this iso code

createCurrency

@Deprecated(since="ages",
            forRemoval=false)
public Currency createCurrency(PK pkBase,
 String isoCode)
                        throws ConsistencyCheckException

Deprecated.

since ages - use plainCurrencyModel creation instead see createCurrency(String) see also model saving example.

Creates a new Currency with the specified iso code.

Parameters:

pkBase - the PK of the new Currency

isoCode - the iso code of the new Currency

Returns:

the new Currency

Throws:

ConsistencyCheckException - if there already exists a Currency with this iso code

getAllCurrencies

@Deprecated(since="ages",
            forRemoval=false)
public Set<Currency> getAllCurrencies()

Deprecated.

since ages - useCommonI18NService.getAllCurrencies() instead.

Returns a Collection of all currencies.

Returns:

a Collection of all currencies

getActiveCurrencies

@Deprecated(since="ages",
            forRemoval=false)
public Set<Currency> getActiveCurrencies()

Deprecated.

since ages - useCommonI18NService.getAllCurrencies() instead.

Returns a Collection of all active currencies (GeneratedC2LItem.isActive() == true ). This is meant to provide a way to select only the currencies which should be shown in applications ( web ) even though a larger number of them exists.

Returns:

a Collection of all active currencies

getBaseCurrency

@Deprecated(since="ages",
            forRemoval=false)
public Currency getBaseCurrency()

Deprecated.

since ages - useCommonI18NService.getBaseCurrency() instead.

Returns the base currency (GeneratedCurrency.isBase()) of this system or Null if no base currency is set. There should be always one such Currency in the hybris Platform. The base currency should be the most likely-to-us currency.

Returns:

the base Currency or Null if no base currency is set

setBaseCurrency

@Deprecated(since="ages",
            forRemoval=false)
public void setBaseCurrency(Currency currency)

Deprecated.

since ages - use {Currency#setBase()} instead.

Sets the specified Currency as the base currency of this system.

Parameters:

currency - the new base currency

See Also:

• getBaseCurrency()

getCountryByIsoCode

@Deprecated(since="ages",
            forRemoval=false)
public Country getCountryByIsoCode(String iso)
                            throws JaloItemNotFoundException

Deprecated.

since ages - useCommonI18NService.getCountry(String) instead.

Returns the Country with the specified isocode.

Parameters:

iso - the isocode of the searched Country

Returns:

the Country with the specified isocode

Throws:

JaloItemNotFoundException - if no Country with the specified isocode exists

createCountry

@Deprecated(since="ages",
            forRemoval=false)
public Country createCountry(String isoCode)
                      throws ConsistencyCheckException

Deprecated.

since ages - use plainCountryModel creation instead :

 
 final CountryModel model = modelService.create(CountryModel.class);
 model.setIsocode("tinyRed");
 modelService.save(model);
 
 

see also model saving example.

Creates a new Country with the specified isocode. The isocode of the Country must be unique within the countries.

Parameters:

isoCode - the isocode of the new country

Returns:

the new Country

Throws:

ConsistencyCheckException - if the isocode is not unique within the countries

createCountry

@Deprecated(since="ages",
            forRemoval=false)
public Country createCountry(PK pkBase,
 String isoCode)
                      throws ConsistencyCheckException

Deprecated.

since ages - use plainCountryModel creation instead see createCountry(String), see also model saving example

Creates a new Country with the specified isocode. The isocode of the Country must be unique within the countries.

Parameters:

pkBase - the primary key of the new Country

isoCode - the isocode of the new country

Returns:

the new Country

Throws:

ConsistencyCheckException - if the isocode is not unique within the countries

getAllCountries

@Deprecated(since="ages",
            forRemoval=false)
public Set<Country> getAllCountries()

Deprecated.

since ages - useCommonI18NService.getAllCountries() instead.

Returns a Collection of all countries.

Returns:

a Collection of all countries

getActiveCountries

@Deprecated(since="ages",
            forRemoval=false)
public Set<Country> getActiveCountries()

Deprecated.

since ages - useCommonI18NService.getAllCountries() instead.

Returns a Collection of all active countries.

Returns:

a Collection of all active countries.

getRegionByCode

@Deprecated(since="ages",
            forRemoval=false)
public Region getRegionByCode(String code)
                       throws JaloItemNotFoundException,
JaloSystemException

Deprecated.

since ages - You should consider not using region data without its country context , in that case use CommonI18NService.getRegion(de.hybris.platform.core.model.c2l.CountryModel, String) instead.

Returns the Region with the specified code. If there exists no Region with the specified code, a JaloItemNotFoundException is thrown. If there are more than one Region with the specified code, a JaloSystemException is thrown.

Parameters:

code - the code of the searched Region

Returns:

the Region with the specified code

Throws:

JaloItemNotFoundException - if there exists no Region with the specified code

JaloSystemException - if there are more than one Region with the specified code

getRegionsByCode

@Deprecated(since="ages",
            forRemoval=false)
public Collection<Region> getRegionsByCode(String code)

Deprecated.

since ages - You should consider not using region data without its country context, in that use CommonI18NService.getRegion(de.hybris.platform.core.model.c2l.CountryModel, String) instead.

Returns a Collection of regions which match the specified code code.

Parameters:

code - the code of the searched regions

Returns:

a Collection of regions which match the specified code code

getRegionByCode

@Deprecated(since="ages",
            forRemoval=false)
public Region getRegionByCode(Country country,
 String code)
                       throws JaloItemNotFoundException

Deprecated.

since ages - use CommonI18NService.getRegion(de.hybris.platform.core.model.c2l.CountryModel, String) instead.

Returns the Region with the specified code which is assigned to the specified Country. Throws a JaloItemNotFoundException if no matching Region is found.

Parameters:

country - the Country, the Region should belong to

code - the code of the searched region

Returns:

the Region with the specified code which is assigned to the specified Country.

Throws:

JaloItemNotFoundException - if no matching Region is found

createRegion

@Deprecated(since="ages",
            forRemoval=false)
public Region createRegion(String code,
 Country country)
                    throws ConsistencyCheckException

Deprecated.

since ages - please useCountry.addNewRegion(String) instead

Creates a new region for the specified Country with the given code.

Parameters:

code - the code of the new Region

country - the Country the new Region belongs to

Returns:

the new Region

Throws:

ConsistencyCheckException - if a Region with the specified code already exists for the specified Country

createRegion

@Deprecated(since="ages",
            forRemoval=false)
public Region createRegion(PK pkBase,
 String code,
 Country country)
                    throws ConsistencyCheckException

Deprecated.

since ages - use plainRegionModel creation instead see also model saving example.

Creates a new region for the specified Country with the given code.

Parameters:

pkBase - the primary key of the new region. Must be unique.

code - the code of the new Region

country - the Country the new Region belongs to

Returns:

the new Region

Throws:

ConsistencyCheckException - if a Region with the specified code already exists for the specified Country

getRegions

@Deprecated(since="ages",
            forRemoval=false)
public Collection<Region> getRegions(Country country)

Deprecated.

since ages - useCountryModel.getRegions() instead.

Returns a Collection of all regions which are assigned to the specified Country.

Parameters:

country - the Country whose regions should be returned

Returns:

a Collection of all regions which are assigned to the specified Country

getAllRegions

@Deprecated(since="ages",
            forRemoval=false)
public Set<Region> getAllRegions()

Deprecated.

since ages - useCommonI18NService.getAllRegions() instead.

Returns a Collection of all regions, regardless which Country they belong to.

Returns:

a Collection of all regions, regardless which Country they belong to

getActiveRegions

@Deprecated(since="ages",
            forRemoval=false)
public Set<Region> getActiveRegions()

Deprecated.

since ages - useCommonI18NService.getAllRegions() instead.

Returns a Collection of all active regions, regardless which Country they belong to.

Returns:

a Collection of all active regions, regardless which Country they belong to

writeReplace

public Object writeReplace()
                    throws ObjectStreamException

Specified by:

writeReplace in class Manager

Throws:

ObjectStreamException

notifyItemRemoval

protected void notifyItemRemoval(SessionContext ctx,
 Item item)

Description copied from class: Manager

TODO improve API doc Is called just before a item is being removed. No exception should be thrown here. Use Manager.checkBeforeItemRemoval(SessionContext, Item) instead.

This method does nothing and may be overridden.

Overrides:

notifyItemRemoval in class Manager

Parameters:

ctx - the currency session context

item - the item which is going to be removed