com.konakartadmin.bl

Class AdminCurrencyMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminCurrencyMgr

All Implemented Interfaces:

AdminCurrencyMgrIf

public class AdminCurrencyMgr
extends AdminBaseMgr
implements AdminCurrencyMgrIf

The AdminCurrencyMgr - for Managing Currency Objects for the Admin Application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminCurrencyMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex
protected static java.util.Map<java.lang.String,AdminCurrencyMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminCurrencyMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected int	addCurrencySearchCriteria(com.konakart.db.KKCriteria c, AdminCurrencySearch search)
protected void	addOrderBy(com.konakart.db.KKCriteria c, AdminCurrencySearch search)
int	deleteCurrency(int currId) Delete a Currency
boolean	doesCurrencyExistForId(int currId) Checks to see whether a currency already exists with this id
protected AdminCurrency	fetchDefaultCurrency() The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
java.lang.String	formatPrice(java.math.BigDecimal number) Calls formatPrice with the default currency
java.lang.String	formatPrice(java.math.BigDecimal number, java.lang.String currencyCode) Used to create a string in order to visualize a price.
AdminCurrencySearchResult	getCurrencies(AdminCurrencySearch search) This returns an array of currencies for all of the currencies in the currency table.
AdminCurrency	getCurrency(int currencyId) Returns the currency referenced by the currencyId.
AdminCurrency	getCurrency(java.lang.String currencyCode) Returns the currency referenced by the currencyCode.
AdminCurrency	getDefaultCurrency() The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
java.text.DecimalFormat	getDefaultCurrencyFormatter() Gets the formatter for the default currency
protected java.text.DecimalFormat	getFormatter(AdminCurrency currency) Get a DecimalFormat object for a currency
int	insertCurrency(AdminCurrency curr) Insert a Currency
void	refreshConfigs() Refresh the configuration of the Admin Currency Manager
void	setDefaultCurrency(java.lang.String currCode) Sets the default currency.
int	updateCurrency(AdminCurrency curr) Update a Currency

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

mutex

protected static java.lang.String mutex

staticDataHM

protected static java.util.Map<java.lang.String,AdminCurrencyMgr.StaticData> staticDataHM

Hash Map that contains the static data

Constructor Detail

AdminCurrencyMgr

public AdminCurrencyMgr(KKAdminIf eng)
                 throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

setDefaultCurrency

public void setDefaultCurrency(java.lang.String currCode)
                        throws java.lang.Exception

Sets the default currency. Sets a configuration variable called DEFAULT_CURRENCY.

Specified by:

setDefaultCurrency in interface AdminCurrencyMgrIf

Parameters:

currCode - the currCode

Throws:

java.lang.Exception - an unexpected exception

getDefaultCurrency

public AdminCurrency getDefaultCurrency()
                                 throws java.lang.Exception

The default currency is referenced by a configuration variable called DEFAULT_CURRENCY. If this isn't found then we return the currency in the currency table with the lowest id. Once found, the default currency is cached.

Specified by:

getDefaultCurrency in interface AdminCurrencyMgrIf

Returns:

Returns a currency

Throws:

java.lang.Exception - an unexpected exception

fetchDefaultCurrency

protected AdminCurrency fetchDefaultCurrency()
                                      throws java.lang.Exception

The default currency is referenced by a configuration variable called DEFAULT_CURRENCY. If this isn't found then we return the currency in the currency table with the lowest id. Once found, the default currency is cached.

Returns:

Returns a currency

Throws:

java.lang.Exception - an unexpected exception

getDefaultCurrencyFormatter

public java.text.DecimalFormat getDefaultCurrencyFormatter()
                                                    throws KKAdminException

Gets the formatter for the default currency

Specified by:

getDefaultCurrencyFormatter in interface AdminCurrencyMgrIf

Returns:

Default currency formatter

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getCurrency

public AdminCurrency getCurrency(java.lang.String currencyCode)
                          throws KKAdminException,
                                 org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException

Returns the currency referenced by the currencyCode.

Specified by:

getCurrency in interface AdminCurrencyMgrIf

Parameters:

currencyCode - the currencyCode

Returns:

Returns a currency or null if there is no currency with the specified code

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getCurrency

public AdminCurrency getCurrency(int currencyId)
                          throws org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException

Returns the currency referenced by the currencyId.

Specified by:

getCurrency in interface AdminCurrencyMgrIf

Parameters:

currencyId - the currencyId

Returns:

Returns a currency or null if there is no currency with the specified currencyId

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getCurrencies

public AdminCurrencySearchResult getCurrencies(AdminCurrencySearch search)
                                        throws org.apache.torque.TorqueException,
                                               com.workingdogs.village.DataSetException

This returns an array of currencies for all of the currencies in the currency table.

Specified by:

getCurrencies in interface AdminCurrencyMgrIf

Parameters:

search - the search

Returns:

Returns an array of currencies

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

addCurrencySearchCriteria

protected int addCurrencySearchCriteria(com.konakart.db.KKCriteria c,
                                        AdminCurrencySearch search)

addOrderBy

protected void addOrderBy(com.konakart.db.KKCriteria c,
                          AdminCurrencySearch search)

formatPrice

public java.lang.String formatPrice(java.math.BigDecimal number)
                             throws java.lang.Exception

Calls formatPrice with the default currency

Specified by:

formatPrice in interface AdminCurrencyMgrIf

Parameters:

number - the number

Returns:

Returns the formatted currency

Throws:

java.lang.Exception - an unexpected exception

formatPrice

public java.lang.String formatPrice(java.math.BigDecimal number,
                                    java.lang.String currencyCode)
                             throws java.lang.Exception

Used to create a string in order to visualize a price. It ensures that the decimal places, the thousands seperator and the currency symbol are correct.

Specified by:

formatPrice in interface AdminCurrencyMgrIf

Parameters:

number - the number

currencyCode - the currencyCode

Returns:

The formatted price or null if the number specified is null

Throws:

java.lang.Exception - an unexpected exception

getFormatter

protected java.text.DecimalFormat getFormatter(AdminCurrency currency)

Get a DecimalFormat object for a currency

Parameters:

currency - the currency

Returns:

Returns a DecimalFormat object for the given currency

deleteCurrency

public int deleteCurrency(int currId)
                   throws KKAdminException

Delete a Currency

Specified by:

deleteCurrency in interface AdminCurrencyMgrIf

Parameters:

currId - A currency id

Returns:

returns the id of the deleted currency

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

insertCurrency

public int insertCurrency(AdminCurrency curr)
                   throws KKAdminException

Insert a Currency

Specified by:

insertCurrency in interface AdminCurrencyMgrIf

Parameters:

curr - A currency object

Returns:

returns the id of the inserted currency

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

updateCurrency

public int updateCurrency(AdminCurrency curr)
                   throws java.lang.Exception

Update a Currency

Specified by:

updateCurrency in interface AdminCurrencyMgrIf

Parameters:

curr - A currrency object

Returns:

returns the id of the updated currency

Throws:

java.lang.Exception - an unexpected exception

doesCurrencyExistForId

public boolean doesCurrencyExistForId(int currId)
                               throws org.apache.torque.TorqueException

Checks to see whether a currency already exists with this id

Specified by:

doesCurrencyExistForId in interface AdminCurrencyMgrIf

Parameters:

currId - the currId

Returns:

Returns true if the customer already exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Admin Currency Manager

Specified by:

refreshConfigs in interface AdminCurrencyMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception