Package org.compiere.model

Class MConversionRate

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_C_Conversion_Rate

org.compiere.model.MConversionRate

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_C_Conversion_Rate, I_Persistent, Evaluatee

public class MConversionRate
extends X_C_Conversion_Rate

Currency Conversion Rate Model

Version:

$Id: MConversionRate.java,v 1.2 2006/07/30 00:58:18 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_C_Conversion_Rate

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_C_Conversion_Rate_ID, COLUMNNAME_C_Conversion_Rate_UU, COLUMNNAME_C_ConversionType_ID, COLUMNNAME_C_Currency_ID, COLUMNNAME_C_Currency_ID_To, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DivideRate, COLUMNNAME_IsActive, COLUMNNAME_MultiplyRate, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, COLUMNNAME_ValidFrom, COLUMNNAME_ValidTo, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MConversionRate(Properties ctx, int C_Conversion_Rate_ID, String trxName)	Standard Constructor
MConversionRate(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MConversionRate(PO po, int C_ConversionType_ID, int C_Currency_ID, int C_Currency_ID_To, BigDecimal MultiplyRate, Timestamp ValidFrom)	New Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	afterSave(boolean newRecord, boolean success)	Called after Save for Post-Save Operation
protected boolean	beforeSave(boolean newRecord)	Before Save
static BigDecimal	convert(Properties ctx, BigDecimal Amt, int CurFrom_ID, int CurTo_ID, int AD_Client_ID, int AD_Org_ID)	Convert an amount with today's default rate
static BigDecimal	convert(Properties ctx, BigDecimal Amt, int CurFrom_ID, int CurTo_ID, Timestamp ConvDate, int C_ConversionType_ID, int AD_Client_ID, int AD_Org_ID)	Convert an amount
static BigDecimal	convert(Properties ctx, BigDecimal Amt, int CurFrom_ID, int CurTo_ID, Timestamp ConvDate, int C_ConversionType_ID, int AD_Client_ID, int AD_Org_ID, boolean isCosting)	Convert an amount
static BigDecimal	convertBase(Properties ctx, BigDecimal Amt, int CurFrom_ID, Timestamp ConvDate, int C_ConversionType_ID, int AD_Client_ID, int AD_Org_ID)	Convert an amount to base Currency
static BigDecimal	getRate(int CurFrom_ID, int CurTo_ID, Timestamp ConvDate, int ConversionType_ID, int AD_Client_ID, int AD_Org_ID)	Get Currency Conversion Rate
void	setDivideRate(BigDecimal DivideRate)	Set Divide Rate.
void	setMultiplyRate(BigDecimal MultiplyRate)	Set Multiply Rate Sets also Divide Rate
static void	setRate(String CurFrom_ISO, String CurTo_ISO, Date spotDate, BigDecimal MultiplyRate)	Sets system spot conversion rate for a single day.
String	toString()	String Representation

Methods inherited from class org.compiere.model.X_C_Conversion_Rate

get_AccessLevel, getC_Conversion_Rate_ID, getC_Conversion_Rate_UU, getC_ConversionType, getC_ConversionType_ID, getC_Currency, getC_Currency_ID, getC_Currency_ID_To, getC_Currency_To, getDivideRate, getKeyNamePair, getMultiplyRate, getValidFrom, getValidTo, initPO, setC_Conversion_Rate_ID, setC_Conversion_Rate_UU, setC_ConversionType_ID, setC_Currency_ID, setC_Currency_ID_To, setValidFrom, setValidTo

Methods inherited from class org.compiere.model.PO

afterDelete, beforeDelete, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_C_Conversion_Rate

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Detail

MConversionRate

public MConversionRate(Properties ctx,
                       int C_Conversion_Rate_ID,
                       String trxName)

Standard Constructor

Parameters:

ctx - context

C_Conversion_Rate_ID - id

trxName - transaction

MConversionRate

public MConversionRate(Properties ctx,
                       ResultSet rs,
                       String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MConversionRate

public MConversionRate(PO po,
                       int C_ConversionType_ID,
                       int C_Currency_ID,
                       int C_Currency_ID_To,
                       BigDecimal MultiplyRate,
                       Timestamp ValidFrom)

New Constructor

Parameters:

po - parent

C_ConversionType_ID - conversion type

C_Currency_ID - currency

C_Currency_ID_To - currency to

MultiplyRate - multiply rate

ValidFrom - valid from

Method Detail

convertBase

public static BigDecimal convertBase(Properties ctx,
                                     BigDecimal Amt,
                                     int CurFrom_ID,
                                     Timestamp ConvDate,
                                     int C_ConversionType_ID,
                                     int AD_Client_ID,
                                     int AD_Org_ID)

Convert an amount to base Currency

Parameters:

ctx - context

CurFrom_ID - The C_Currency_ID FROM

ConvDate - conversion date - if null - use current date

C_ConversionType_ID - conversion rate type - if 0 - use Default

Amt - amount to be converted

AD_Client_ID - client

AD_Org_ID - organization

Returns:

converted amount

convert

public static BigDecimal convert(Properties ctx,
                                 BigDecimal Amt,
                                 int CurFrom_ID,
                                 int CurTo_ID,
                                 int AD_Client_ID,
                                 int AD_Org_ID)

Convert an amount with today's default rate

Parameters:

ctx - context

CurFrom_ID - The C_Currency_ID FROM

CurTo_ID - The C_Currency_ID TO

Amt - amount to be converted

AD_Client_ID - client

AD_Org_ID - organization

Returns:

converted amount

convert

public static BigDecimal convert(Properties ctx,
                                 BigDecimal Amt,
                                 int CurFrom_ID,
                                 int CurTo_ID,
                                 Timestamp ConvDate,
                                 int C_ConversionType_ID,
                                 int AD_Client_ID,
                                 int AD_Org_ID)

Convert an amount

Parameters:

ctx - context

CurFrom_ID - The C_Currency_ID FROM

CurTo_ID - The C_Currency_ID TO

ConvDate - conversion date - if null - use current date

C_ConversionType_ID - conversion rate type - if 0 - use Default

Amt - amount to be converted

AD_Client_ID - client

AD_Org_ID - organization

Returns:

converted amount or null if no rate

convert

public static BigDecimal convert(Properties ctx,
                                 BigDecimal Amt,
                                 int CurFrom_ID,
                                 int CurTo_ID,
                                 Timestamp ConvDate,
                                 int C_ConversionType_ID,
                                 int AD_Client_ID,
                                 int AD_Org_ID,
                                 boolean isCosting)

Convert an amount

Parameters:

ctx - context

Amt - amount to be converted

CurFrom_ID - The C_Currency_ID FROM

CurTo_ID - The C_Currency_ID TO

ConvDate - conversion date - if null - use current date

C_ConversionType_ID - conversion rate type - if 0 - use Default

AD_Client_ID - client

AD_Org_ID - organization

isCosting - use for costing

Returns:

converted amount or null if no rate

setRate

public static void setRate(String CurFrom_ISO,
                           String CurTo_ISO,
                           Date spotDate,
                           BigDecimal MultiplyRate)
                    throws Exception

Sets system spot conversion rate for a single day. Checks for overlaps of spot rate is made. If an overlap is found, the overlapping rate is removed.

Parameters:

CurFrom_ISO - Currency from ISO code

CurTo_ISO - Currency to ISO code

spotDate - If null, today's date is used.

MultiplyRate - CurFrom_ISO * MultiplyRate = amount in CurTo_ISO

Throws:

Exception

getRate

public static BigDecimal getRate(int CurFrom_ID,
                                 int CurTo_ID,
                                 Timestamp ConvDate,
                                 int ConversionType_ID,
                                 int AD_Client_ID,
                                 int AD_Org_ID)

Get Currency Conversion Rate

Parameters:

CurFrom_ID - The C_Currency_ID FROM

CurTo_ID - The C_Currency_ID TO

ConvDate - The Conversion date - if null - use current date

ConversionType_ID - Conversion rate type - if 0 - use Default

AD_Client_ID - client

AD_Org_ID - organization

Returns:

currency Rate or null

setMultiplyRate

public void setMultiplyRate(BigDecimal MultiplyRate)

Set Multiply Rate Sets also Divide Rate

Specified by:

setMultiplyRate in interface I_C_Conversion_Rate

Overrides:

setMultiplyRate in class X_C_Conversion_Rate

Parameters:

MultiplyRate - multiply rate

setDivideRate

public void setDivideRate(BigDecimal DivideRate)

Set Divide Rate. Sets also Multiply Rate

Specified by:

setDivideRate in interface I_C_Conversion_Rate

Overrides:

setDivideRate in class X_C_Conversion_Rate

Parameters:

DivideRate - divide rate

toString

public String toString()

String Representation

Overrides:

toString in class X_C_Conversion_Rate

Returns:

info

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save. - Same Currency - Date Range Check - Set To date to 2056

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true if OK to save

afterSave

protected boolean afterSave(boolean newRecord,
                            boolean success)

Description copied from class: PO

Called after Save for Post-Save Operation

Overrides:

afterSave in class PO

Parameters:

newRecord - new record

success - true if save operation was success

Returns:

if save was a success