Package mc.core.domain.i18n

Class I18nRI

java.lang.Object

mc.core.system.base.BaseBean

mc.core.domain.base.AbstractAPI

mc.core.domain.i18n.I18nRI

@Path("/")
@Produces("application/json")
public class I18nRI
extends AbstractAPI

The i18n (internationalization) REST API exposes relevant functions of the i18n API as REST enabled endpoints. This includes Locale, Unit, Country, Currency, Dictionary , Pricelist and Territory.

Constructor Summary

Constructors

Constructor	Description
I18nRI()

Method Summary

Modifier and Type	Method	Description
void	countryDelete(String key)	DELETE: country/{key}
void	countryDelete(Country country)	Checks if country is used.
javax.ws.rs.core.Response	countryEdit(String key)	POST: country/{key}?data=[json]
javax.ws.rs.core.Response	countryInsert()	POST: country?data=[json]
Country	countrySave(Country country, DataMap map)	Inserts or updates given country by setting its fields from given dataMap.
void	countryToggleActivation(String key)	POST: country/{key}/toggleactivation
void	countryToggleActivation(Country country)	Activates given country if inactive, otherwise sets inactive.
void	currencyDelete(String key)	DELETE: currency/{key}
void	currencyDelete(Currency currency)	Checks if currency is used.
javax.ws.rs.core.Response	currencyEdit(String key)	POST: currency/{key}?data=[json]
javax.ws.rs.core.Response	currencyInsert()	POST: currency?data=[json]
Currency	currencySave(Currency currency, DataMap map)	Inserts or updates given currency by setting its fields from given dataMap.
void	currencyToggleActivation(String key)	POST: currency/{key}/toggleactivation
void	currencyToggleActivation(Currency currency)	Activates given currency if inactive, otherwise sets inactive.
javax.ws.rs.core.Response	dictionaryAddItem(String key)	POST: dictionary/{key}/item?data=[json]
void	dictionaryAddItem(Dictionary dictionary, DictionaryItem dictionaryItem)	Adds the dictionaryItem to the dictionary and stores the dictionaryItem in the database if not already persistent.
void	dictionaryDelete(String key)	DELETE: dictionary/{key}
void	dictionaryDelete(Dictionary dictionary)	Checks if dictionary is used.
void	dictionaryDeleteItem(Dictionary dictionary, DictionaryItem dictionaryItem)	Deletes the dictionaryItem from the dictionary and the database.
javax.ws.rs.core.Response	dictionaryEdit(String key)	POST: dictionary/{key}?data=[json]
javax.ws.rs.core.Response	dictionaryInsert()	POST: dictionary?data=[json]
void	dictionaryItemDelete(String key)	DELETE: dictionaryitem/{key}
javax.ws.rs.core.Response	dictionaryItemEdit(String key)	POST: dictionaryitem/{key}?data=[json]
DictionaryItem	dictionaryItemSave(DictionaryItem dictionaryItem, DataMap map)	Stores the dictionaryItem and the contained resource property in the database.
Dictionary	dictionarySave(Dictionary dictionary, DataMap map)	Inserts or updates given dictionary by setting its fields from given dataMap.
void	dictionaryToggleActivation(String key)	POST: dictionary/{key}/toggleactivation
void	dictionaryToggleActivation(Dictionary dictionary)	Activates given dictionary if inactive, otherwise sets inactive.
void	languageDelete(String key)	DELETE: language/{key}
void	languageDelete(Language language)	Checks if language is used.
javax.ws.rs.core.Response	languageEdit(String key)	POST: language/{key}?data=[json]
javax.ws.rs.core.Response	languageInsert()	POST: language?data=[json]
Language	languageSave(Language language, DataMap map)	Inserts or updates given language by setting its fields from given dataMap.
void	languageToggleActivation(String key)	POST: language/{key}/toggleactivation
void	languageToggleActivation(Language language)	Activates given language, otherwise sets inactive.
void	localeDelete(String key)	DELETE: locale/{key}
void	localeDelete(Locale locale)	Checks if locale is used.
javax.ws.rs.core.Response	localeEdit(String key)	POST: locale/{key}?data=[json]
List<Locale>	localeGetAllActive()	Gets all locales marked as isActive and not as isSystem (default and undefined locale).
javax.ws.rs.core.Response	localeGetAllActiveRI()	GET: locale/active
Locale	localeGetDefault()	Returns the system's default locale.
javax.ws.rs.core.Response	localeGetDefaultRI()	GET: locale/default
Locale	localeGetUndefined()	Returns the system's undefined locale.
javax.ws.rs.core.Response	localeGetUndefinedRI()	GET: locale/undefined
javax.ws.rs.core.Response	localeInsert()	POST: locale?data=[json]
Locale	localeSave(Locale locale, DataMap map)	Inserts or updates given locale by setting its fields from given dataMap.
void	localeToggleActivation(String key)	POST: locale/{key}/toggleactivation
void	localeToggleActivation(Locale locale)	Activates given locale if inactive, otherwise sets inactive.
void	pricelistDelete(String key)	DELETE: pricelist/{key}
void	pricelistDelete(Pricelist pricelist)	Checks if pricelist is used.
javax.ws.rs.core.Response	pricelistEdit(String key)	POST: pricelist/{key}?data=[json]
javax.ws.rs.core.Response	pricelistInsert()	POST: pricelist?data=[json]
Pricelist	pricelistSave(Pricelist pricelist, DataMap map)	Inserts or updates given Pricelist by setting its fields from given dataMap.
void	territoryDelete(String key)	DELETE: territory/{key}
void	territoryDelete(Territory territory)	Checks if territory is used.
javax.ws.rs.core.Response	territoryEdit(String key)	POST: territory/{key}?data=[json]
List<Territory>	territoryGetAllActive()	Gets all territories marked as isActive and not as isSystem
javax.ws.rs.core.Response	territoryInsert()	POST: territory?data=[json]
Territory	territorySave(Territory territory, DataMap map)	Inserts or updates given territory by setting its fields from given dataMap.
void	territoryToggleActivation(String key)	POST: territory/{key}/toggleactivation
void	territoryToggleActivation(Territory territory)	Activates given territory if inactive, otherwise sets inactive.
void	unitDelete(String key)	DELETE: unit/{key}
void	unitDelete(Unit unit)	Checks if unit is used.
javax.ws.rs.core.Response	unitEdit(String key)	POST: unit/{key}?data=[json]
javax.ws.rs.core.Response	unitInsert()	POST: unit?data=[json]
Unit	unitSave(Unit unit, DataMap map)	Inserts or updates given unit by setting its fields from given dataMap.
void	unitToggleActivation(String key)	POST: unit/{key}/toggleactivation
void	unitToggleActivation(Unit unit)	Activates given unit if inactive, otherwise sets inactive.

Methods inherited from class mc.core.domain.base.AbstractAPI

getAll, getAll, getFromId, getFromInternalDescription, getReference, ref, ref

Methods inherited from class java.lang.Object

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

Constructor Details

I18nRI

public I18nRI()

Method Details

localeGetDefaultRI

@GET
@Path("locale/default")
public javax.ws.rs.core.Response localeGetDefaultRI()
                                             throws ApplicationException,
IOException

GET: locale/default

Get the default locale.

Throws:

ApplicationException

IOException

See Also:

• I18nAPI.localeGetDefault()

localeGetUndefinedRI

@GET
@Path("locale/undefined")
public javax.ws.rs.core.Response localeGetUndefinedRI()
                                               throws ApplicationException,
IOException

GET: locale/undefined

Get the undefined locale.

Throws:

ApplicationException

IOException

See Also:

• I18nAPI.localeGetUndefined()

localeGetAllActiveRI

@GET
@Path("locale/active")
public javax.ws.rs.core.Response localeGetAllActiveRI()
                                               throws ApplicationException,
IOException

GET: locale/active

Get the list of active locales.

Throws:

ApplicationException

IOException

See Also:

• I18nAPI.localeGetAllActive()

localeInsert

@POST
@Path("locale")
public javax.ws.rs.core.Response localeInsert()
                                       throws UserException,
ApplicationException,
IOException

POST: locale?data=[json]

Insert a new locale with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.localeSave(Locale, DataMap)

localeEdit

@POST
@Path("locale/{key}")
public javax.ws.rs.core.Response localeEdit(@PathParam("key")
 String key)
                                     throws UserException,
ApplicationException,
IOException

POST: locale/{key}?data=[json]

Update given locale with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.localeSave(Locale, DataMap)

localeDelete

@DELETE
@Path("locale/{key}")
public void localeDelete(@PathParam("key")
 String key)
                  throws UserException,
ApplicationException

DELETE: locale/{key}

Delete given locale.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.localeDelete(Locale)

localeToggleActivation

@POST
@Path("locale/{key}/toggleactivation")
public void localeToggleActivation(@PathParam("key")
 String key)
                            throws UserException,
ApplicationException

POST: locale/{key}/toggleactivation

Toggle activation for given locale.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.localeToggleActivation(Locale)

countryInsert

@POST
@Path("country")
public javax.ws.rs.core.Response countryInsert()
                                        throws UserException,
ApplicationException,
IOException

POST: country?data=[json]

Insert a new country with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.countrySave(Country, DataMap)

countryEdit

@POST
@Path("country/{key}")
public javax.ws.rs.core.Response countryEdit(@PathParam("key")
 String key)
                                      throws UserException,
ApplicationException,
IOException

POST: country/{key}?data=[json]

Update given country with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.countrySave(Country, DataMap)

countryDelete

@DELETE
@Path("country/{key}")
public void countryDelete(@PathParam("key")
 String key)
                   throws UserException,
ApplicationException

DELETE: country/{key}

Delete given country.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.countryDelete(Country)

countryToggleActivation

@POST
@Path("country/{key}/toggleactivation")
public void countryToggleActivation(@PathParam("key")
 String key)
                             throws UserException,
ApplicationException

POST: country/{key}/toggleactivation

Toggle activation for given country.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.countryToggleActivation(Country)

currencyInsert

@POST
@Path("currency")
public javax.ws.rs.core.Response currencyInsert()
                                         throws UserException,
ApplicationException,
IOException

POST: currency?data=[json]

Insert currency with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.currencySave(Currency, DataMap)

currencyEdit

@POST
@Path("currency/{key}")
public javax.ws.rs.core.Response currencyEdit(@PathParam("key")
 String key)
                                       throws UserException,
ApplicationException,
IOException

POST: currency/{key}?data=[json]

Update given currency with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.currencySave(Currency, DataMap)

currencyDelete

@DELETE
@Path("currency/{key}")
public void currencyDelete(@PathParam("key")
 String key)
                    throws UserException,
ApplicationException

DELETE: currency/{key}

Delete given currency.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.currencyDelete(Currency)

currencyToggleActivation

@POST
@Path("currency/{key}/toggleactivation")
public void currencyToggleActivation(@PathParam("key")
 String key)
                              throws UserException,
ApplicationException

POST: currency/{key}/toggleactivation

Toggle activation for given currency.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.currencyToggleActivation(Currency)

languageInsert

public javax.ws.rs.core.Response languageInsert()
                                         throws UserException,
ApplicationException,
IOException

POST: language?data=[json]

Insert language with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.languageSave(Language, DataMap)

languageEdit

public javax.ws.rs.core.Response languageEdit(@PathParam("key")
 String key)
                                       throws UserException,
ApplicationException,
IOException

POST: language/{key}?data=[json]

Update given language with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.languageSave(Language, DataMap)

languageDelete

public void languageDelete(@PathParam("key")
 String key)
                    throws UserException,
ApplicationException

DELETE: language/{key}

Delete given language.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.languageDelete(Language)

languageToggleActivation

@POST
@Path("language/{key}/toggleactivation")
public void languageToggleActivation(@PathParam("key")
 String key)
                              throws UserException,
ApplicationException

POST: language/{key}/toggleactivation

Toggle activation for given language.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.languageToggleActivation(Language)

unitInsert

@POST
@Path("unit")
public javax.ws.rs.core.Response unitInsert()
                                     throws UserException,
ApplicationException,
IOException

POST: unit?data=[json]

Insert unit with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.unitSave(Unit, DataMap)

unitEdit

@POST
@Path("unit/{key}")
public javax.ws.rs.core.Response unitEdit(@PathParam("key")
 String key)
                                   throws UserException,
ApplicationException,
IOException

POST: unit/{key}?data=[json]

Update unit with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.unitSave(Unit, DataMap)

unitDelete

@DELETE
@Path("unit/{key}")
public void unitDelete(@PathParam("key")
 String key)
                throws UserException,
ApplicationException

DELETE: unit/{key}

Delete given unit.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.unitDelete(Unit)

unitToggleActivation

@POST
@Path("unit/{key}/toggleactivation")
public void unitToggleActivation(@PathParam("key")
 String key)
                          throws UserException,
ApplicationException

POST: unit/{key}/toggleactivation

Toggle activation for given unit.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.unitToggleActivation(Unit)

pricelistInsert

@POST
@Path("pricelist")
public javax.ws.rs.core.Response pricelistInsert()
                                          throws UserException,
ApplicationException,
IOException

POST: pricelist?data=[json]

Insert new pricelist with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.pricelistSave(Pricelist, DataMap)

pricelistEdit

@POST
@Path("pricelist/{key}")
public javax.ws.rs.core.Response pricelistEdit(@PathParam("key")
 String key)
                                        throws UserException,
ApplicationException,
IOException

POST: pricelist/{key}?data=[json]

Update given pricelist with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.pricelistSave(Pricelist, DataMap)

pricelistDelete

@DELETE
@Path("pricelist/{key}")
public void pricelistDelete(@PathParam("key")
 String key)
                     throws UserException,
ApplicationException

DELETE: pricelist/{key}

Delete given pricelist.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.pricelistDelete(Pricelist)

territoryInsert

@POST
@Path("territory")
public javax.ws.rs.core.Response territoryInsert()
                                          throws UserException,
ApplicationException,
IOException

POST: territory?data=[json]

Insert territory with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.territorySave(Territory, DataMap)

territoryEdit

@POST
@Path("territory/{key}")
public javax.ws.rs.core.Response territoryEdit(@PathParam("key")
 String key)
                                        throws UserException,
ApplicationException,
IOException

POST: territory/{key}?data=[json]

Update given territory with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.territorySave(Territory, DataMap)

territoryDelete

@DELETE
@Path("territory/{key}")
public void territoryDelete(@PathParam("key")
 String key)
                     throws UserException,
ApplicationException

DELETE: territory/{key}

Delete given territory.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.territoryDelete(Territory)

territoryToggleActivation

@POST
@Path("territory/{key}/toggleactivation")
public void territoryToggleActivation(@PathParam("key")
 String key)
                               throws UserException,
ApplicationException

POST: territory/{key}/toggleactivation

Toggle activation for given territory.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.territoryToggleActivation(Territory)

dictionaryInsert

@POST
@Path("dictionary")
public javax.ws.rs.core.Response dictionaryInsert()
                                           throws UserException,
ApplicationException,
IOException

POST: dictionary?data=[json]

Insert dictionary with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.dictionarySave(Dictionary, DataMap)

dictionaryEdit

@POST
@Path("dictionary/{key}")
public javax.ws.rs.core.Response dictionaryEdit(@PathParam("key")
 String key)
                                         throws UserException,
ApplicationException,
IOException

POST: dictionary/{key}?data=[json]

Update given dictionary with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.dictionarySave(Dictionary, DataMap)

dictionaryDelete

@DELETE
@Path("dictionary/{key}")
public void dictionaryDelete(@PathParam("key")
 String key)
                      throws UserException,
ApplicationException

DELETE: dictionary/{key}

Delete given dictionary.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.dictionaryDelete(Dictionary)

dictionaryToggleActivation

@POST
@Path("dictionary/{key}/toggleactivation")
public void dictionaryToggleActivation(@PathParam("key")
 String key)
                                throws UserException,
ApplicationException

POST: dictionary/{key}/toggleactivation

Toggle activation of given dictionary.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.dictionaryToggleActivation(Dictionary)

dictionaryAddItem

@POST
@Path("dictionary/{key}/item")
public javax.ws.rs.core.Response dictionaryAddItem(@PathParam("key")
 String key)
                                            throws UserException,
ApplicationException,
IOException

POST: dictionary/{key}/item?data=[json]

Add item to given dictionary with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.dictionaryAddItem(Dictionary, DictionaryItem)
• I18nAPI.dictionaryItemSave(DictionaryItem, DataMap)

dictionaryItemEdit

@POST
@Path("dictionaryitem/{key}")
public javax.ws.rs.core.Response dictionaryItemEdit(@PathParam("key")
 String key)
                                             throws UserException,
ApplicationException,
IOException

POST: dictionaryitem/{key}?data=[json]

Update given dictionary item with data from json map.

Throws:

UserException

ApplicationException

IOException

See Also:

• I18nAPI.dictionaryItemSave(DictionaryItem, DataMap)

dictionaryItemDelete

@DELETE
@Path("dictionaryitem/{key}")
public void dictionaryItemDelete(@PathParam("key")
 String key)
                          throws UserException,
ApplicationException

DELETE: dictionaryitem/{key}

Delete given dictionary item.

Throws:

UserException

ApplicationException

See Also:

• I18nAPI.dictionaryDeleteItem(Dictionary, DictionaryItem)

localeGetDefault

public Locale localeGetDefault()
                        throws mc.core.system.configuration.ConfigurationException

Returns the system's default locale. There should always exist exactly one default Locale.

Returns:

the default Locale entity

Throws:

mc.core.system.configuration.ConfigurationException - if there is no default Locale or if there is more than one locale marked as default (by setting their internalDescription to "DEFAULT").

localeGetUndefined

public Locale localeGetUndefined()
                          throws mc.core.system.configuration.ConfigurationException

Returns the system's undefined locale. The undefined locale is used for locale independent attribute values. There should always exist exactly one undefined locale.

Returns:

the undefined Locale entity

Throws:

mc.core.system.configuration.ConfigurationException - if there is no undefined locale or if there is more than one locale marked as undefined (by setting their internalDescription to "UNDEFINED").

localeGetAllActive

public List<Locale> localeGetAllActive()

Gets all locales marked as isActive and not as isSystem (default and undefined locale).

Returns:

list of Locale entities

localeSave

public Locale localeSave(Locale locale,
 DataMap map)
                  throws UserException,
ApplicationException

Inserts or updates given locale by setting its fields from given dataMap. A locale must always have a language, either as entity in locale or as key in dataMap.

Parameters:

locale - mandatory

map - optional, contains values for the locale's fields as key-value pairs.

Returns:

inserted or updated Locale entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

localeDelete

public void localeDelete(Locale locale)
                  throws UserException,
ApplicationException

Checks if locale is used. If not removes it from database.

Parameters:

locale - mandatory

Throws:

UserException - if Locale is in use or user has not role CONFIGADMIN

ApplicationException

See Also:

• for usage of Locale

localeToggleActivation

public void localeToggleActivation(Locale locale)
                            throws UserException,
ApplicationException

Activates given locale if inactive, otherwise sets inactive.

Parameters:

locale - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

countrySave

public Country countrySave(Country country,
 DataMap map)
                    throws UserException,
ApplicationException

Inserts or updates given country by setting its fields from given dataMap.

Parameters:

country - mandatory

map - optional, contains values for the country's fields as key-value pairs.

Returns:

inserted or updated Country entry

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

countryDelete

public void countryDelete(Country country)
                   throws UserException,
DeleteTiedElementException,
ApplicationException

Checks if country is used. If not removes it from database.

Parameters:

country - mandatory

Throws:

UserException - user has not role CONFIGADMIN

DeleteTiedElementException - if country is in use

ApplicationException

See Also:

• for usage of Country

countryToggleActivation

public void countryToggleActivation(Country country)
                             throws UserException,
ApplicationException

Activates given country if inactive, otherwise sets inactive. If country has been activated creates a territory for this country without extension if not already exist and sets it active. There should be a territory for each active country because territory is used in the application rather than country.

Parameters:

country - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

currencySave

public Currency currencySave(Currency currency,
 DataMap map)
                      throws UserException,
ApplicationException

Inserts or updates given currency by setting its fields from given dataMap.

Parameters:

currency - mandatory

map - optional, contains values for the currency's fields as key-value pairs.

Returns:

inserted or updated Currency entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

currencyDelete

public void currencyDelete(Currency currency)
                    throws UserException,
DeleteTiedElementException,
ApplicationException

Checks if currency is used. If not removes it from database.

Parameters:

currency - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

DeleteTiedElementException - if currency is in use

ApplicationException

See Also:

• for usage of Currency

currencyToggleActivation

public void currencyToggleActivation(Currency currency)
                              throws UserException,
ApplicationException

Activates given currency if inactive, otherwise sets inactive.

Parameters:

currency - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

languageSave

public Language languageSave(Language language,
 DataMap map)
                      throws UserException,
ApplicationException

Inserts or updates given language by setting its fields from given dataMap.

Parameters:

language - mandatory

map - optional, contains values for the language's fields as key-value pairs.

Returns:

inserted or updated Language entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

languageDelete

public void languageDelete(Language language)
                    throws UserException,
DeleteTiedElementException,
ApplicationException

Checks if language is used. If not removes it from database.

Parameters:

language - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

DeleteTiedElementException - if language is in use

ApplicationException

See Also:

• for usage of Language.

languageToggleActivation

public void languageToggleActivation(Language language)
                              throws UserException,
ApplicationException

Activates given language, otherwise sets inactive. If language has been activated creates a locale for this language without country and extension if not already exist and sets it active. There should be a locale for each active language because locale is used in the application rather than language.

Parameters:

language - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

unitSave

public Unit unitSave(Unit unit,
 DataMap map)
              throws UserException,
ApplicationException

Inserts or updates given unit by setting its fields from given dataMap.

Parameters:

unit - mandatory

map - optional, contains values for the unit's fields as key-value pairs.

Returns:

inserted or updated Unit entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

unitToggleActivation

public void unitToggleActivation(Unit unit)
                          throws UserException,
ApplicationException

Activates given unit if inactive, otherwise sets inactive.

Parameters:

unit - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

unitDelete

public void unitDelete(Unit unit)
                throws UserException,
DeleteTiedElementException,
ApplicationException

Checks if unit is used. If not removes it from database.

Parameters:

unit - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

DeleteTiedElementException - if unit is in use

ApplicationException

See Also:

• for usage of Unit

pricelistSave

public Pricelist pricelistSave(Pricelist pricelist,
 DataMap map)
                        throws UserException,
ApplicationException

Inserts or updates given Pricelist by setting its fields from given dataMap.

Parameters:

pricelist - mandatory

map - mandatory, contains values for the Pricelist's fields as key-value pairs

Returns:

inserted or updated Pricelist entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

pricelistDelete

public void pricelistDelete(Pricelist pricelist)
                     throws UserException,
DeleteTiedElementException,
ApplicationException

Checks if pricelist is used. If not removes it from database.

Parameters:

pricelist - mandatory

Throws:

ApplicationException

DeleteTiedElementException - if pricelist is in use

UserException - if user has not role CONFIGADMIN

See Also:

• for usage of Pricelist

territorySave

public Territory territorySave(Territory territory,
 DataMap map)
                        throws UserException,
ApplicationException

Inserts or updates given territory by setting its fields from given dataMap.

Parameters:

territory - mandatory

map - optional, contains values for the territory's fields as key-value pairs

Returns:

inserted or updated Territory entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

territoryDelete

public void territoryDelete(Territory territory)
                     throws UserException,
DeleteTiedElementException,
ApplicationException

Checks if territory is used. If not removes it from database.

Parameters:

territory - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

DeleteTiedElementException - if territory is in use

ApplicationException

See Also:

• for usage of Territory

territoryToggleActivation

public void territoryToggleActivation(Territory territory)
                               throws UserException,
ApplicationException

Activates given territory if inactive, otherwise sets inactive.

Parameters:

territory - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

territoryGetAllActive

public List<Territory> territoryGetAllActive()

Gets all territories marked as isActive and not as isSystem

Returns:

list of Territory entities

dictionarySave

public Dictionary dictionarySave(Dictionary dictionary,
 DataMap map)
                          throws UserException,
ApplicationException

Inserts or updates given dictionary by setting its fields from given dataMap.

Parameters:

dictionary - mandatory

map - optional, contains values for the dictionary's fields as key-value pairs

Returns:

inserted or updated Dictionary entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

dictionaryDelete

public void dictionaryDelete(Dictionary dictionary)
                      throws UserException,
DeleteTiedElementException,
ApplicationException

Checks if dictionary is used. if not removes it from database.

Parameters:

dictionary - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

DeleteTiedElementException - if dictionary is in use

ApplicationException

dictionaryToggleActivation

public void dictionaryToggleActivation(Dictionary dictionary)
                                throws UserException,
ApplicationException

Activates given dictionary if inactive, otherwise sets inactive.

Parameters:

dictionary - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

dictionaryAddItem

public void dictionaryAddItem(Dictionary dictionary,
 DictionaryItem dictionaryItem)
                       throws UserException,
ApplicationException

Adds the dictionaryItem to the dictionary and stores the dictionaryItem in the database if not already persistent. new items must already have the mandatory resource property set.

Parameters:

dictionary - mandatory

dictionaryItem - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

See Also:

• #dictionaryItemSave(DictionaryItem dictionaryItem, ParamMap paramMap)

dictionaryDeleteItem

public void dictionaryDeleteItem(Dictionary dictionary,
 DictionaryItem dictionaryItem)
                          throws UserException,
ApplicationException

Deletes the dictionaryItem from the dictionary and the database.

Parameters:

dictionary - mandatory

dictionaryItem - mandatory

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException

dictionaryItemSave

public DictionaryItem dictionaryItemSave(DictionaryItem dictionaryItem,
 DataMap map)
                                  throws UserException,
ApplicationException

Stores the dictionaryItem and the contained resource property in the database.

Parameters:

dictionaryItem - mandatory

map - optional, contains values for the dictionaryItem's fields as key-value pairs

Returns:

inserted or updated DictionaryItem entity

Throws:

UserException - if user has not role CONFIGADMIN

ApplicationException