psdi.app.currency

Class CurrencyService

java.lang.Object

psdi.server.AppService

psdi.app.currency.CurrencyService

All Implemented Interfaces:

java.rmi.Remote, CurrencyServiceRemote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class CurrencyService
extends AppService
implements CurrencyServiceRemote

Field Summary

Fields inherited from class psdi.server.AppService

currentState, dbManager, INIT, liveObjCount, load, LOAD, mxServer, name, RUN, running, stateCmdList, stateList, STOP, url

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
CurrencyService() The currency code object.
CurrencyService(MXServer mxServer) The Server environment this service is created in.

Method Summary

Modifier and Type	Method and Description
double	calculateCurrencyCost(UserInfo userInfo, java.lang.String currencyFrom, java.lang.String currencyTo, double value, java.util.Date date, java.lang.String orgId) Calculates the To currency cost given From currency code, From currency cost, To currency code and date.
java.lang.String	getBaseCurrency1(java.lang.String orgID, UserInfo user) Return the base currency1 which is now stored at the organization level.
java.lang.String	getBaseCurrency2(java.lang.String orgID, UserInfo user) Return the base currency2 which is now stored at the organization level.
double	getCurrencyExchangeRate(UserInfo userInfo, java.lang.String currencyCodeFrom, java.lang.String currencyCodeTo, java.util.Date exchangeDate, java.lang.String orgId) This is a generic method that returns the exchange rate for converting one currency code to another.
boolean	isABaseCurrency(java.lang.String currency, UserInfo user)

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCriteriaList, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, init, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setName, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Constructor Detail

CurrencyService

public CurrencyService()
                throws java.rmi.RemoteException

The currency code object.

Throws:

java.rmi.RemoteException

CurrencyService

public CurrencyService(MXServer mxServer)
                throws java.rmi.RemoteException

The Server environment this service is created in.

Parameters:

mxServer - Mxserver

Throws:

java.rmi.RemoteException

Method Detail

calculateCurrencyCost

public double calculateCurrencyCost(UserInfo userInfo,
                                    java.lang.String currencyFrom,
                                    java.lang.String currencyTo,
                                    double value,
                                    java.util.Date date,
                                    java.lang.String orgId)
                             throws MXException,
                                    java.rmi.RemoteException

Calculates the To currency cost given From currency code, From currency cost, To currency code and date. This is a generic method that calculates the cost equivalent of one currency to another using the exchange rate.

Specified by:

calculateCurrencyCost in interface CurrencyServiceRemote

Parameters:

userInfo - user information to instantiate a mbo set

currencyFrom - the From currency code

currencyTo - the To currency code

value - value of currencyfrom to be converted

date - the given date to find an exchange rate

orgId - the orgId associated with the currencyTo

Returns:

converted currency cost

Throws:

MXApplicationException - (currency, InvalidCurrency) is thrown when the given From currency code is not a valid one

MXException

java.rmi.RemoteException

See Also:

Currency.getCurrencyCost(String, double, Date, String)

getCurrencyExchangeRate

public double getCurrencyExchangeRate(UserInfo userInfo,
                                      java.lang.String currencyCodeFrom,
                                      java.lang.String currencyCodeTo,
                                      java.util.Date exchangeDate,
                                      java.lang.String orgId)
                               throws MXException,
                                      java.rmi.RemoteException

This is a generic method that returns the exchange rate for converting one currency code to another.

The three-step method to find an exchange rate between the "From" currency and the "To" currency:

First, an attempt is made to find the requested exchange rate in the EXCHANGE table.

Second, if the exchange rate is not found, an attempt is made to find the inverse of the rate requested, that is, an attempt is made to find the exchange rate for the "To" currency to the "From" currency. If this is found, the inverse (1/rate) is used for the excahnge rate for the "From" currency to the "To" currency.

Third, If the above fail, an attempt is made to find the exchange rates for both the "From" currency to the "Base" currency, and the "To" currency to the "Base" currency. If this succeeds, the desired exchange rate is calculated from these two rates.

If all attempts fail,an exception is thrown.

Specified by:

getCurrencyExchangeRate in interface CurrencyServiceRemote

Parameters:

userInfo - user information to instantiate a mbo set

currencyFrom - the From currency code

currencyTo - the To currency code

date - the given date to find an exchange rate

orgId - organization identifier used to get base currency

Returns:

exchange rate

Throws:

MXApplicationException - (currency, GetExchangeRate) is thrown when the exchange rate cannot be found for the given currency codes

MXException

java.rmi.RemoteException

See Also:

CurrencyService.getCurrencyExchangeRate(UserInfo userInfo,String currencyFrom,String currencyTo,Date date,String orgId)

getBaseCurrency1

public java.lang.String getBaseCurrency1(java.lang.String orgID,
                                         UserInfo user)
                                  throws MXException,
                                         java.rmi.RemoteException

Return the base currency1 which is now stored at the organization level. There should always be a base currency1 for an organization.

Specified by:

getBaseCurrency1 in interface CurrencyServiceRemote

Parameters:

UserInfo - user The information of the user accessing this service.

Returns:

String Return the base currency1.

Throws:

MXException

java.rmi.RemoteException

See Also:

CurrencyService.getBaseCurrency1(String,UserInfo)

getBaseCurrency2

public java.lang.String getBaseCurrency2(java.lang.String orgID,
                                         UserInfo user)
                                  throws MXException,
                                         java.rmi.RemoteException

Return the base currency2 which is now stored at the organization level. The base currency2 for an organization can be null.

Specified by:

getBaseCurrency2 in interface CurrencyServiceRemote

Parameters:

UserInfo - user The information of the user accessing this service.

Returns:

String Return the base currency2.

Throws:

MXException

java.rmi.RemoteException

See Also:

CurrencyService.getBaseCurrency2(String,UserInfo)

isABaseCurrency

public boolean isABaseCurrency(java.lang.String currency,
                               UserInfo user)
                        throws MXException,
                               java.rmi.RemoteException

Specified by:

isABaseCurrency in interface CurrencyServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

CurrencyService.isABaseCurrency(String currency, UserInfo user)