Package africa.absa.inception.reference

Class ReferenceService

java.lang.Object

africa.absa.inception.reference.ReferenceService

All Implemented Interfaces:

IReferenceService

@Service
public class ReferenceService
extends Object
implements IReferenceService

The ReferenceService class provides the Reference Service implementation.

Author:

Marcus Portmann

Field Summary

Fields inherited from interface africa.absa.inception.reference.IReferenceService

DEFAULT_LOCALE_ID

Constructor Summary

Constructors

Constructor	Description
ReferenceService(CountryRepository countryRepository, LanguageRepository languageRepository, MeasurementSystemRepository measurementSystemRepository, MeasurementUnitRepository measurementUnitRepository, MeasurementUnitTypeRepository measurementUnitTypeRepository, RegionRepository regionRepository)	Constructs a new ReferenceService.

Method Summary

Modifier and Type	Method	Description
List<Country>	getCountries()	Retrieve the country reference data for all locales.
List<Country>	getCountries(String localeId)	Retrieve the country reference data for a specific locale.
List<Language>	getLanguages()	Retrieve the language reference data for all locales.
List<Language>	getLanguages(String localeId)	Retrieve the language reference data for a specific locale.
List<MeasurementSystem>	getMeasurementSystems()	Retrieve the measurement system reference data for all locales.
List<MeasurementSystem>	getMeasurementSystems(String localeId)	Retrieve the measurement system reference data for a specific locale.
List<MeasurementUnit>	getMeasurementUnits()	Retrieve the measurement unit reference data for all locales.
List<MeasurementUnit>	getMeasurementUnits(String localeId)	Retrieve the measurement unit reference data for a specific locale.
List<MeasurementUnitType>	getMeasurementUnitTypes()	Retrieve the measurement unit type reference data for all locales.
List<MeasurementUnitType>	getMeasurementUnitTypes(String localeId)	Retrieve the measurement unit type reference data for a specific locale.
List<Region>	getRegions()	Retrieve the region reference data for all locales.
List<Region>	getRegions(String localeId)	Retrieve the region reference data for a specific locale.
List<TimeZone>	getTimeZones()	Retrieve the time zone reference data for all locales.
List<TimeZone>	getTimeZones(String localeId)	Retrieve the time zone reference data for a specific locale.
boolean	isValidCountry(String countryCode)	Check whether the code is a valid code for a country.
boolean	isValidLanguage(String languageCode)	Check whether the code is a valid ISO 639-1 alpha-2 code for a language.
boolean	isValidMeasurementSystem(String measurementSystemCode)	Check whether the code is a valid code for a measurement system.
boolean	isValidMeasurementUnit(String measurementUnitCode)	Check whether the code is a valid code for a measurement unit.
boolean	isValidMeasurementUnitType(String measurementUnitTypeCode)	Check whether the code is a valid code for a measurement unit type.
boolean	isValidRegion(String regionCode)	Check whether the code is a valid code for a region.
boolean	isValidTimeZone(String timeZoneCode)	Check whether the code is a valid code for a time zone.

Methods inherited from class java.lang.Object

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

Constructor Details

ReferenceService

public ReferenceService(CountryRepository countryRepository,
 LanguageRepository languageRepository,
 MeasurementSystemRepository measurementSystemRepository,
 MeasurementUnitRepository measurementUnitRepository,
 MeasurementUnitTypeRepository measurementUnitTypeRepository,
 RegionRepository regionRepository)

Constructs a new ReferenceService.

Parameters:

countryRepository - the Country Repository

languageRepository - the Language Repository

measurementSystemRepository - the Measurement System Repository

measurementUnitRepository - the Measurement Unit Type Repository

measurementUnitTypeRepository - the Measurement Unit Type Repository

regionRepository - the Region Repository

Method Details

getCountries

@Cacheable(cacheNames="reference",
           key="\'countries.ALL\'")
public List<Country> getCountries()
                           throws ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the country reference data for all locales.

Specified by:

getCountries in interface IReferenceService

Returns:

the country reference data

Throws:

ServiceUnavailableException - if the country reference data could not be retrieved

getCountries

@Cacheable(cacheNames="reference",
           key="\'countries.\' + #localeId")
public List<Country> getCountries(String localeId)
                           throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the country reference data for a specific locale.

Specified by:

getCountries in interface IReferenceService

Parameters:

localeId - the Unicode locale identifier for the locale to retrieve the country reference data for

Returns:

the country reference data

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the country reference data could not be retrieved

getLanguages

@Cacheable(cacheNames="reference",
           key="\'languages.ALL\'")
public List<Language> getLanguages()
                            throws ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the language reference data for all locales.

Specified by:

getLanguages in interface IReferenceService

Returns:

the language reference data

Throws:

ServiceUnavailableException - if the language reference data could not be retrieved

getLanguages

@Cacheable(cacheNames="reference",
           key="\'languages.\' + #localeId")
public List<Language> getLanguages(String localeId)
                            throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the language reference data for a specific locale.

Specified by:

getLanguages in interface IReferenceService

Parameters:

localeId - the Unicode locale identifier for the locale to retrieve the language reference data for

Returns:

the language reference data

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the language reference data could not be retrieved

getMeasurementSystems

@Cacheable(cacheNames="reference",
           key="\'measurementSystems.ALL\'")
public List<MeasurementSystem> getMeasurementSystems()
                                              throws ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the measurement system reference data for all locales.

Specified by:

getMeasurementSystems in interface IReferenceService

Returns:

the measurement system reference data

Throws:

ServiceUnavailableException - if the measurement system reference data could not be retrieved

getMeasurementSystems

@Cacheable(cacheNames="reference",
           key="\'measurementSystems.\' + #localeId")
public List<MeasurementSystem> getMeasurementSystems(String localeId)
                                              throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the measurement system reference data for a specific locale.

Specified by:

getMeasurementSystems in interface IReferenceService

Parameters:

localeId - the Unicode locale identifier for the locale to retrieve the measurement system reference data for

Returns:

the measurement system reference data

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the measurement system reference data could not be retrieved

getMeasurementUnitTypes

@Cacheable(cacheNames="reference",
           key="\'measurementUnitTypes.ALL\'")
public List<MeasurementUnitType> getMeasurementUnitTypes()
                                                  throws ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the measurement unit type reference data for all locales.

Specified by:

getMeasurementUnitTypes in interface IReferenceService

Returns:

the measurement unit type reference data

Throws:

ServiceUnavailableException - if the measurement unit type reference data could not be retrieved

getMeasurementUnitTypes

@Cacheable(cacheNames="reference",
           key="\'measurementUnitTypes.\' + #localeId")
public List<MeasurementUnitType> getMeasurementUnitTypes(String localeId)
                                                  throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the measurement unit type reference data for a specific locale.

Specified by:

getMeasurementUnitTypes in interface IReferenceService

Parameters:

localeId - the Unicode locale identifier for the locale to retrieve the measurement unit type reference data for

Returns:

the measurement unit type reference data

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the measurement unit type reference data could not be retrieved

getMeasurementUnits

@Cacheable(cacheNames="reference",
           key="\'measurementUnits.ALL\'")
public List<MeasurementUnit> getMeasurementUnits()
                                          throws ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the measurement unit reference data for all locales.

Specified by:

getMeasurementUnits in interface IReferenceService

Returns:

the measurement unit reference data

Throws:

ServiceUnavailableException - if the measurement unit reference data could not be retrieved

getMeasurementUnits

@Cacheable(cacheNames="reference",
           key="\'measurementUnits.\' + #localeId")
public List<MeasurementUnit> getMeasurementUnits(String localeId)
                                          throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the measurement unit reference data for a specific locale.

Specified by:

getMeasurementUnits in interface IReferenceService

Parameters:

localeId - the Unicode locale identifier for the locale to retrieve the measurement unit reference data for

Returns:

the measurement unit reference data

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the measurement unit reference data could not be retrieved

getRegions

@Cacheable(cacheNames="reference",
           key="\'regions.ALL\'")
public List<Region> getRegions()
                        throws ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the region reference data for all locales.

Specified by:

getRegions in interface IReferenceService

Returns:

the region reference data

Throws:

ServiceUnavailableException - if the region reference data could not be retrieved

getRegions

@Cacheable(cacheNames="reference",
           key="\'regions.\' + #localeId")
public List<Region> getRegions(String localeId)
                        throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the region reference data for a specific locale.

Specified by:

getRegions in interface IReferenceService

Parameters:

localeId - the Unicode locale identifier for the locale to retrieve the region reference data for

Returns:

the region reference data

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the region reference data could not be retrieved

getTimeZones

@Cacheable(cacheNames="reference",
           key="\'timeZones.ALL\'")
public List<TimeZone> getTimeZones()
                            throws ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the time zone reference data for all locales.

Specified by:

getTimeZones in interface IReferenceService

Returns:

the time zones reference data

Throws:

ServiceUnavailableException - if the time zones reference data could not be retrieved

getTimeZones

@Cacheable(cacheNames="reference",
           key="\'timeZones.\' + #localeId")
public List<TimeZone> getTimeZones(String localeId)
                            throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IReferenceService

Retrieve the time zone reference data for a specific locale.

Specified by:

getTimeZones in interface IReferenceService

Parameters:

localeId - the Unicode locale identifier for the locale to retrieve the time zone reference data for

Returns:

the time zone reference data

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the time zones reference data could not be retrieved

isValidCountry

public boolean isValidCountry(String countryCode)
                       throws ServiceUnavailableException

Description copied from interface: IReferenceService

Check whether the code is a valid code for a country.

Specified by:

isValidCountry in interface IReferenceService

Parameters:

countryCode - the code for the country

Returns:

true if the code is a valid code for a country or false otherwise

Throws:

ServiceUnavailableException - if the country code check failed

isValidLanguage

public boolean isValidLanguage(String languageCode)
                        throws ServiceUnavailableException

Description copied from interface: IReferenceService

Check whether the code is a valid ISO 639-1 alpha-2 code for a language.

Specified by:

isValidLanguage in interface IReferenceService

Parameters:

languageCode - the code for the language

Returns:

true if the code is a valid ISO 639-1 alpha-2 code for a language or false otherwise

Throws:

ServiceUnavailableException - if the language code check failed

isValidMeasurementSystem

public boolean isValidMeasurementSystem(String measurementSystemCode)
                                 throws ServiceUnavailableException

Description copied from interface: IReferenceService

Check whether the code is a valid code for a measurement system.

Specified by:

isValidMeasurementSystem in interface IReferenceService

Parameters:

measurementSystemCode - the code for the measurement system

Returns:

true if the code is a valid code for a measurement system or false otherwise

Throws:

ServiceUnavailableException - if the measurement system code check failed

isValidMeasurementUnit

public boolean isValidMeasurementUnit(String measurementUnitCode)
                               throws ServiceUnavailableException

Description copied from interface: IReferenceService

Check whether the code is a valid code for a measurement unit.

Specified by:

isValidMeasurementUnit in interface IReferenceService

Parameters:

measurementUnitCode - the code for the measurement unit

Returns:

true if the code is a valid code for a measurement unit or false otherwise

Throws:

ServiceUnavailableException - if the measurement unit code check failed

isValidMeasurementUnitType

public boolean isValidMeasurementUnitType(String measurementUnitTypeCode)
                                   throws ServiceUnavailableException

Description copied from interface: IReferenceService

Check whether the code is a valid code for a measurement unit type.

Specified by:

isValidMeasurementUnitType in interface IReferenceService

Parameters:

measurementUnitTypeCode - the code for the measurement unit type

Returns:

true if the code is a valid code for a measurement unit type or false otherwise

Throws:

ServiceUnavailableException - if the measurement unit type code check failed

isValidRegion

public boolean isValidRegion(String regionCode)
                      throws ServiceUnavailableException

Description copied from interface: IReferenceService

Check whether the code is a valid code for a region.

Specified by:

isValidRegion in interface IReferenceService

Parameters:

regionCode - the code for the region

Returns:

true if the code is a valid code for a region or false otherwise

Throws:

ServiceUnavailableException - if the region code check failed

isValidTimeZone

public boolean isValidTimeZone(String timeZoneCode)

Description copied from interface: IReferenceService

Check whether the code is a valid code for a time zone.

Specified by:

isValidTimeZone in interface IReferenceService

Parameters:

timeZoneCode - the code for the time zone

Returns:

true if the code is a valid code for a time zone or false otherwise