CSCountry (GOSS iCM API)

java.lang.Object
- gi.controlsite.objects.CSDatabaseItem
- - gi.controlsite.objects.CSItem
  - - gi.controlsite.objects.CSCountry

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class CSCountry
extends CSItem
```
Class that handles the querying of an iCM country.
The CSCountry class includes methods for the retrieval of a particular country's details.
All such methods require that certain database and key information (country ID, for example) be specified via the set methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSCountry class.

See Also:

CSCountryContent, CSCountryMultiple, CSState, Serialized Form

Field Summary
- Fields inherited from class gi.controlsite.objects.CSItem
  ACCESS_GRANTED, DOES_NOT_EXIST, EMPTY, EXISTS, SECURE_ACCESS_DENIED, SECURE_ACCESS_GRANTED, UPDATE_ACTION_INSERTED, UPDATE_ACTION_UPDATED
- Fields inherited from class gi.controlsite.objects.CSDatabaseItem
  LEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY

Constructor Summary

Constructors
Constructor and Description
`CSCountry()` Creates an empty `CSCountry` object.
`CSCountry(CSCountry objItem)` Creates an empty `CSCountry` object, and initialises it from the contents of the supplied CSItem object.
`CSCountry(java.lang.String strPropertyFile)` Creates a new `CSCountry`, specifying a property file that contains all of the database connection details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Not currently implemented for `CSCountry`.
`boolean`	`exist()` Determines whether a country exists on the database.
`void`	`get()` Retrieves the details of a country from the database.
`java.lang.String`	`getAbbrevThree()` Gets the three character abbreviation of the country.
`java.lang.String`	`getAbbrevTwo()` Gets the two character abbreviation of the country.
`int`	`getCountryNumber()` Gets the number of the country to be used as key information.
`java.lang.String`	`getCurrencyCodeAlpha()` Gets the three character currency code of the country.
`java.lang.Integer`	`getCurrencyCodeNumeric()` Gets the numeric currency code of the country.
`java.lang.Integer`	`getCurrencyMinorDecimalPlaces()` Gets the number of decimals places used to indicate the minor currency unit of the country, for example Pence.
`java.lang.String`	`getCurrencyName()` Gets the currency name of the country.
`java.lang.String`	`getCurrencySymbol()` Gets the currency symbol of the country.
`java.lang.String`	`getEnglishName()` Gets the name of the country in English.
`java.lang.Double`	`getExchangeRate()` Gets the exchange rate to be used to convert prices held on the database into the equivalent price for the country.
`java.lang.String`	`getFrenchName()` Gets the name of the country in French.
`java.lang.String`	`getGermanName()` Gets the name of the country in German.
`java.lang.String`	`getName()` Gets the official name of the country.
`void`	`setAbbrevThree(java.lang.String strAbbrevThree)` Sets the three character abbreviation of the country.
`void`	`setAbbrevTwo(java.lang.String strAbbrevTwo)` Sets the two character abbreviation of the country.
`void`	`setCountryNumber(int nCountryNumber)` Sets the number of the country to be used as key information.
`void`	`setCurrencyCodeAlpha(java.lang.String strCurrencyCodeAlpha)` Sets the three character currency code of the country.
`void`	`setCurrencyCodeNumeric(java.lang.Integer nCurrencyCodeNumeric)` Sets the numeric currency code of the country.
`void`	`setCurrencyMinorDecimalPlaces(java.lang.Integer nDecimalPlaces)` Sets the number of decimals places used to indicate the minor currency unit of the country, for example Pence.
`void`	`setCurrencyName(java.lang.String strCurrencyName)` Sets the currency name of the country.
`void`	`setCurrencySymbol(java.lang.String strCurrencySymbol)` Sets the currency symbol of the country.
`void`	`setDetailLevel(int nDetailLevel)` Sets the level of detail to be handled by the `get` method.
`void`	`setEnglishName(java.lang.String strEnglishName)` Sets the name of the country in English.
`void`	`setExchangeRate(java.lang.Double nExchangeRate)` Sets the exchange rate to be used to convert prices held on the database into the equivalent price for the country.
`void`	`setFrenchName(java.lang.String strFrenchName)` Sets the name of the country in French.
`void`	`setGermanName(java.lang.String strGermanName)` Sets the name of the country in German.
`void`	`setName(java.lang.String strName)` Sets the official name of the country.
`void`	`update()` Not currently implemented for `CSCountry`.

Methods inherited from class gi.controlsite.objects.CSItem
equals, getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, toString, unset

Methods inherited from class gi.controlsite.objects.CSDatabaseItem
clearRecordedGatewayMessages, clone, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CSCountry
```
public CSCountry()
```
    Creates an empty CSCountry object.
    Use the various set methods provided to initialise the CSCountry object prior to invoking any of its query methods.
  - CSCountry
```
public CSCountry(CSCountry objItem)
```
    Creates an empty CSCountry object, and initialises it from the contents of the supplied CSItem object.
    
    Parameters:
    
    objItem - the CSCountry object to be used to initialise the new one
  - CSCountry
```
public CSCountry(java.lang.String strPropertyFile)
```
    Creates a new CSCountry, specifying a property file that contains all of the database connection details.
    Use the various set methods provided to initialise the CSCountry object prior to invoking any of its query methods.
    
    Parameters:
    
    strPropertyFile - the property file that contains the connection details.
- Method Detail
  - getCountryNumber
```
public int getCountryNumber()
```
    Gets the number of the country to be used as key information.
    
    Returns:
    
    The country's number to be used as key information.
  - setCountryNumber
```
public void setCountryNumber(int nCountryNumber)
```
    Sets the number of the country to be used as key information.
    setCountryNumber followed by a call to get will return details of the country with the specified number.
    
    Parameters:
    
    nCountryNumber - the country's number to be used as key information.
  - getAbbrevTwo
```
public java.lang.String getAbbrevTwo()
```
    Gets the two character abbreviation of the country.
    
    Returns:
    
    The country's two character abbreviation.
  - setAbbrevTwo
```
public void setAbbrevTwo(java.lang.String strAbbrevTwo)
```
    Sets the two character abbreviation of the country.
    
    Parameters:
    
    strAbbrevTwo - the country's two character abbreviation.
  - getAbbrevThree
```
public java.lang.String getAbbrevThree()
```
    Gets the three character abbreviation of the country.
    
    Returns:
    
    The country's three character abbreviation.
  - setAbbrevThree
```
public void setAbbrevThree(java.lang.String strAbbrevThree)
```
    Sets the three character abbreviation of the country.
    
    Parameters:
    
    strAbbrevThree - the country's three character abbreviation.
  - getName
```
public java.lang.String getName()
```
    Gets the official name of the country.
    
    Returns:
    
    The country's official name.
  - setName
```
public void setName(java.lang.String strName)
```
    Sets the official name of the country.
    
    Parameters:
    
    strName - the country's official name.
  - getEnglishName
```
public java.lang.String getEnglishName()
```
    Gets the name of the country in English.
    
    Returns:
    
    The country's name in English.
  - setEnglishName
```
public void setEnglishName(java.lang.String strEnglishName)
```
    Sets the name of the country in English.
    
    Parameters:
    
    strEnglishName - the country's name in English.
  - getFrenchName
```
public java.lang.String getFrenchName()
```
    Gets the name of the country in French.
    
    Returns:
    
    The country's name in French.
  - setFrenchName
```
public void setFrenchName(java.lang.String strFrenchName)
```
    Sets the name of the country in French.
    
    Parameters:
    
    strFrenchName - the country's name in French.
  - getGermanName
```
public java.lang.String getGermanName()
```
    Gets the name of the country in German.
    
    Returns:
    
    The country's name in German.
  - setGermanName
```
public void setGermanName(java.lang.String strGermanName)
```
    Sets the name of the country in German.
    
    Parameters:
    
    strGermanName - the country's name in German.
  - getCurrencySymbol
```
public java.lang.String getCurrencySymbol()
```
    Gets the currency symbol of the country.
    
    Returns:
    
    The country's currency symbol.
  - setCurrencySymbol
```
public void setCurrencySymbol(java.lang.String strCurrencySymbol)
```
    Sets the currency symbol of the country.
    
    Parameters:
    
    strCurrencySymbol - the country's currency symbol.
  - getCurrencyName
```
public java.lang.String getCurrencyName()
```
    Gets the currency name of the country.
    
    Returns:
    
    The country's currency name.
  - setCurrencyName
```
public void setCurrencyName(java.lang.String strCurrencyName)
```
    Sets the currency name of the country.
    
    Parameters:
    
    strCurrencyName - the country's currency name.
  - getCurrencyCodeAlpha
```
public java.lang.String getCurrencyCodeAlpha()
```
    Gets the three character currency code of the country.
    
    Returns:
    
    The country's three character currency code.
  - setCurrencyCodeAlpha
```
public void setCurrencyCodeAlpha(java.lang.String strCurrencyCodeAlpha)
```
    Sets the three character currency code of the country.
    
    Parameters:
    
    strCurrencyCodeAlpha - the country's three character currency code.
  - getCurrencyCodeNumeric
```
public java.lang.Integer getCurrencyCodeNumeric()
```
    Gets the numeric currency code of the country.
    
    Returns:
    
    The country's numeric currency code.
  - setCurrencyCodeNumeric
```
public void setCurrencyCodeNumeric(java.lang.Integer nCurrencyCodeNumeric)
```
    Sets the numeric currency code of the country.
    
    Parameters:
    
    nCurrencyCodeNumeric - the country's numeric currency code.
  - getCurrencyMinorDecimalPlaces
```
public java.lang.Integer getCurrencyMinorDecimalPlaces()
```
    Gets the number of decimals places used to indicate the minor currency unit of the country, for example Pence.
    
    Returns:
    
    The decimal places of the country's minor currency unit.
  - setCurrencyMinorDecimalPlaces
```
public void setCurrencyMinorDecimalPlaces(java.lang.Integer nDecimalPlaces)
```
    Sets the number of decimals places used to indicate the minor currency unit of the country, for example Pence.
    
    Parameters:
    
    nDecimalPlaces - the decimal places of the country's minor currency unit.
  - getExchangeRate
```
public java.lang.Double getExchangeRate()
```
    Gets the exchange rate to be used to convert prices held on the database into the equivalent price for the country.
    
    Returns:
    
    The country's exchange rate.
  - setExchangeRate
```
public void setExchangeRate(java.lang.Double nExchangeRate)
```
    Sets the exchange rate to be used to convert prices held on the database into the equivalent price for the country.
    
    Parameters:
    
    nExchangeRate - the country's exchange rate.
  - setDetailLevel
```
public void setDetailLevel(int nDetailLevel)
                    throws CSParameterException
```
    Sets the level of detail to be handled by the get method. Default is LEVEL_ALL.
    Valid detail levels for a country are :
    - LEVEL_ID Retrieves the CountryNumber.
    - LEVEL_SUMMARY Retrieves the CountryName.
    - LEVEL_DETAIL Retrieves the AbbrevTwo, AbbrevThree, CurrencySymbol, CurrencyName, CurrencyCodeAlpha, CurrencyCodeNumeric, CurrencyMinorDecimalPlaces, ExchangeRate.
    - LEVEL_ALL Retrieves all country data.
    Overrides:
    
    setDetailLevel in class CSDatabaseItem
    
    Parameters:
    
    nDetailLevel - the detail level to be used.
    
    Throws:
    
    CSParameterException - if an invalid detail level is specified.
  - exist
```
public boolean exist()
              throws CSException
```
    Determines whether a country exists on the database.
    Use setCountryNumber followed by exist to ascertain if there is a country with the specified number on the database.
    Use setName followed by exist to ascertain if there is a country with the specified official name on the database.
    
    Overrides:
    
    exist in class CSItem
    
    Returns:
    
    true if this country exists on the database.
    
    Throws:
    
    CSParameterException - if an invalid combination of key information has been supplied.
    
    CSDatabaseException - if there are problems accessing the database.
    
    CSSecurityException - if security has been breached.
    
    CSException - the base class for exceptions thrown by this method.
  - get
```
public void get()
         throws CSException
```
    Retrieves the details of a country from the database.
    If it is not necessary to retrieve all the details of the country then specify the amount of detail required using the setDetailLevel method before calling this method.
    Use setCountryNumber followed by get to populate this CSCountry object with the details of the country identified by the specified number.
    Use setName followed by get to populate this CSCountry object with the details of the country identified by the specified official name.
    
    Overrides:
    
    get in class CSItem
    
    Throws:
    
    CSParameterException - if an invalid combination of key information has been supplied.
    
    CSDatabaseException - if there are problems accessing the database.
    
    CSNotFoundException - if the specified country cannot be found on the database.
    
    CSSecurityException - if security has been breached.
    
    CSException - the base class for exceptions thrown by this method.
  - update
```
public void update()
            throws CSException
```
    Not currently implemented for CSCountry.
    
    Overrides:
    
    update in class CSItem
    
    Throws:
    
    CSParameterException - if an invalid combination of key information has been supplied.
    
    CSDatabaseException - if there are problems accessing the database.
    
    CSNotFoundException - if one of the specified countries cannot be found on the database.
    
    CSException - the base class for exceptions thrown by this method.
  - delete
```
public void delete()
            throws CSException
```
    Not currently implemented for CSCountry.
    
    Overrides:
    
    delete in class CSItem
    
    Throws:
    
    CSParameterException - if an invalid combination of key information has been supplied.
    
    CSDatabaseException - if there are problems accessing the database.
    
    CSNotFoundException - if one of the specified countries cannot be found on the database.
    
    CSException - the base class for exceptions thrown by this method.

Class CSCountry

Field Summary

Fields inherited from class gi.controlsite.objects.CSItem

Fields inherited from class gi.controlsite.objects.CSDatabaseItem

Constructor Summary

Method Summary

Methods inherited from class gi.controlsite.objects.CSItem

Methods inherited from class gi.controlsite.objects.CSDatabaseItem

Methods inherited from class java.lang.Object

Constructor Detail

CSCountry

CSCountry

CSCountry

Method Detail

getCountryNumber

setCountryNumber

getAbbrevTwo

setAbbrevTwo

getAbbrevThree

setAbbrevThree

getName

setName

getEnglishName

setEnglishName

getFrenchName

setFrenchName

getGermanName

setGermanName

getCurrencySymbol

setCurrencySymbol

getCurrencyName

setCurrencyName

getCurrencyCodeAlpha

setCurrencyCodeAlpha

getCurrencyCodeNumeric

setCurrencyCodeNumeric

getCurrencyMinorDecimalPlaces

setCurrencyMinorDecimalPlaces

getExchangeRate

setExchangeRate

setDetailLevel

exist

get

update

delete