Package org.openbravo.model.common.currency

Class ConversionRate

java.lang.Object

org.openbravo.base.structure.BaseOBObject

org.openbravo.model.common.currency.ConversionRate

All Implemented Interfaces:

Serializable, BaseOBObjectDef, OBNotSingleton, OBProvidable, ActiveEnabled, ClientEnabled, DynamicEnabled, Identifiable, OrganizationEnabled, Traceable

public class ConversionRate
extends BaseOBObject
implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled

Entity class for entity CurrencyConversionRate (stored in table C_Conversion_Rate).
Help: The Conversion Rate defines the rates to use when converting a source currency to an accounting or reporting currency. The Conversion Rates tab is used to define conversion rates to be used when converting document amounts from one currency to another. Conversion rates can be defined for multiple rate types. They can also be effective for a defined range of dates.
NOTE: This class should not be instantiated directly. To instantiate this class the OBProvider should be used.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENTITY_NAME
static String	PROPERTY_ACTIVE	Property active stored in column IsActive in table C_Conversion_Rate
static String	PROPERTY_CLIENT	Property client stored in column AD_Client_ID in table C_Conversion_Rate
static String	PROPERTY_CONVERSIONRATETYPE	Property conversionRateType stored in column ConversionRateType in table C_Conversion_Rate Help: The Conversion Rate Type indicates the type of conversion rate. This allows you to enter multiple rates for the same currency pair. For example, one rate may be used for Spot conversions and a different rate for Revaluations.
static String	PROPERTY_CREATEDBY	Property createdBy stored in column CreatedBy in table C_Conversion_Rate
static String	PROPERTY_CREATIONDATE	Property creationDate stored in column Created in table C_Conversion_Rate
static String	PROPERTY_CURRENCY	Property currency stored in column C_Currency_ID in table C_Conversion_Rate Help: Indicates the currency to be used when processing this document.
static String	PROPERTY_DIVIDERATEBY	Property divideRateBy stored in column DivideRate in table C_Conversion_Rate Help: To convert Source number to Target number, the Source is divided by the divide rate. If you enter a Divide Rate, the Multiply Rate will be automatically calculated.
static String	PROPERTY_ID	Property id stored in column C_Conversion_Rate_ID in table C_Conversion_Rate
static String	PROPERTY_MULTIPLERATEBY	Property multipleRateBy stored in column MultiplyRate in table C_Conversion_Rate Help: To convert Source number to Target number, the Source is multiplied by the multiply rate. If the Multiply Rate is entered, then the Divide Rate will be automatically calculated.
static String	PROPERTY_ORGANIZATION	Property organization stored in column AD_Org_ID in table C_Conversion_Rate
static String	PROPERTY_TOCURRENCY	Property toCurrency stored in column C_Currency_ID_To in table C_Conversion_Rate Help: The Currency To defines the target currency for this conversion rate.
static String	PROPERTY_UPDATED	Property updated stored in column Updated in table C_Conversion_Rate
static String	PROPERTY_UPDATEDBY	Property updatedBy stored in column UpdatedBy in table C_Conversion_Rate
static String	PROPERTY_VALIDFROMDATE	Property validFromDate stored in column ValidFrom in table C_Conversion_Rate
static String	PROPERTY_VALIDTODATE	Property validToDate stored in column ValidTo in table C_Conversion_Rate Help: The Valid To date indicates the last day of a date range
static String	TABLE_NAME

Fields inherited from class org.openbravo.base.structure.BaseOBObject

ID

Constructor Summary

Constructors

Constructor	Description
ConversionRate()

Method Summary

Modifier and Type	Method	Description
Client	getClient()	Client field
String	getConversionRateType()
User	getCreatedBy()	Created by audit user
Date	getCreationDate()	Creation date of audit
Currency	getCurrency()
BigDecimal	getDivideRateBy()
String	getEntityName()
String	getId()
BigDecimal	getMultipleRateBy()
Organization	getOrganization()	Gets organization field
Currency	getToCurrency()
Date	getUpdated()	Update date of audit
User	getUpdatedBy()	Update by audit user
Date	getValidFromDate()
Date	getValidToDate()
Boolean	isActive()	Gets active field
void	setActive(Boolean active)	Sets active field
void	setClient(Client client)	Client field
void	setConversionRateType(String conversionRateType)
void	setCreatedBy(User createdBy)	Created by audit user
void	setCreationDate(Date creationDate)	Creation date of audit
void	setCurrency(Currency currency)
void	setDivideRateBy(BigDecimal divideRateBy)
void	setId(String id)
void	setMultipleRateBy(BigDecimal multipleRateBy)
void	setOrganization(Organization organization)	Sets organization field
void	setToCurrency(Currency toCurrency)
void	setUpdated(Date updated)	Update date of audit
void	setUpdatedBy(User updatedBy)	Update by audit user
void	setValidFromDate(Date validFromDate)
void	setValidToDate(Date validToDate)

Methods inherited from class org.openbravo.base.structure.BaseOBObject

checkDerivedReadable, get, get, get, getEntity, getIdentifier, getValue, isAllowRead, isNewOBObject, isOrgClientAccessCheckEnabled, isWriteAccessCheckEnabled, set, setAccessChecks, setAllowRead, setDefaultValue, setId, setNewOBObject, setValue, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_NAME

public static final String TABLE_NAME

See Also:

Constant Field Values

ENTITY_NAME

public static final String ENTITY_NAME

See Also:

Constant Field Values

PROPERTY_ID

public static final String PROPERTY_ID

Property id stored in column C_Conversion_Rate_ID in table C_Conversion_Rate

See Also:

Constant Field Values

PROPERTY_CLIENT

public static final String PROPERTY_CLIENT

Property client stored in column AD_Client_ID in table C_Conversion_Rate

See Also:

ClientEnabled, Constant Field Values

PROPERTY_ORGANIZATION

public static final String PROPERTY_ORGANIZATION

Property organization stored in column AD_Org_ID in table C_Conversion_Rate

See Also:

OrganizationEnabled, Constant Field Values

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

Property active stored in column IsActive in table C_Conversion_Rate

See Also:

ActiveEnabled, Constant Field Values

PROPERTY_CREATIONDATE

public static final String PROPERTY_CREATIONDATE

Property creationDate stored in column Created in table C_Conversion_Rate

See Also:

Traceable, Constant Field Values

PROPERTY_CREATEDBY

public static final String PROPERTY_CREATEDBY

Property createdBy stored in column CreatedBy in table C_Conversion_Rate

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATED

public static final String PROPERTY_UPDATED

Property updated stored in column Updated in table C_Conversion_Rate

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATEDBY

public static final String PROPERTY_UPDATEDBY

Property updatedBy stored in column UpdatedBy in table C_Conversion_Rate

See Also:

Traceable, Constant Field Values

PROPERTY_CURRENCY

public static final String PROPERTY_CURRENCY

Property currency stored in column C_Currency_ID in table C_Conversion_Rate
Help: Indicates the currency to be used when processing this document.

See Also:

Constant Field Values

PROPERTY_TOCURRENCY

public static final String PROPERTY_TOCURRENCY

Property toCurrency stored in column C_Currency_ID_To in table C_Conversion_Rate
Help: The Currency To defines the target currency for this conversion rate.

See Also:

Constant Field Values

PROPERTY_VALIDFROMDATE

public static final String PROPERTY_VALIDFROMDATE

Property validFromDate stored in column ValidFrom in table C_Conversion_Rate

See Also:

Constant Field Values

PROPERTY_VALIDTODATE

public static final String PROPERTY_VALIDTODATE

Property validToDate stored in column ValidTo in table C_Conversion_Rate
Help: The Valid To date indicates the last day of a date range

See Also:

Constant Field Values

PROPERTY_CONVERSIONRATETYPE

public static final String PROPERTY_CONVERSIONRATETYPE

Property conversionRateType stored in column ConversionRateType in table C_Conversion_Rate
Help: The Conversion Rate Type indicates the type of conversion rate. This allows you to enter multiple rates for the same currency pair. For example, one rate may be used for Spot conversions and a different rate for Revaluations.

See Also:

Constant Field Values

PROPERTY_MULTIPLERATEBY

public static final String PROPERTY_MULTIPLERATEBY

Property multipleRateBy stored in column MultiplyRate in table C_Conversion_Rate
Help: To convert Source number to Target number, the Source is multiplied by the multiply rate. If the Multiply Rate is entered, then the Divide Rate will be automatically calculated.

See Also:

Constant Field Values

PROPERTY_DIVIDERATEBY

public static final String PROPERTY_DIVIDERATEBY

Property divideRateBy stored in column DivideRate in table C_Conversion_Rate
Help: To convert Source number to Target number, the Source is divided by the divide rate. If you enter a Divide Rate, the Multiply Rate will be automatically calculated.

See Also:

Constant Field Values

Constructor Detail

ConversionRate

public ConversionRate()

Method Detail

getEntityName

public String getEntityName()

Specified by:

getEntityName in interface Identifiable

Specified by:

getEntityName in class BaseOBObject

getId

public String getId()

Specified by:

getId in interface BaseOBObjectDef

Specified by:

getId in interface Identifiable

Overrides:

getId in class BaseOBObject

See Also:

PROPERTY_ID

setId

public void setId(String id)

See Also:

PROPERTY_ID

getClient

public Client getClient()

Description copied from interface: ClientEnabled

Client field

Specified by:

getClient in interface ClientEnabled

Returns:

client

See Also:

PROPERTY_CLIENT

setClient

public void setClient(Client client)

Description copied from interface: ClientEnabled

Client field

Specified by:

setClient in interface ClientEnabled

See Also:

PROPERTY_CLIENT

getOrganization

public Organization getOrganization()

Description copied from interface: OrganizationEnabled

Gets organization field

Specified by:

getOrganization in interface OrganizationEnabled

Returns:

organization

See Also:

PROPERTY_ORGANIZATION

setOrganization

public void setOrganization(Organization organization)

Description copied from interface: OrganizationEnabled

Sets organization field

Specified by:

setOrganization in interface OrganizationEnabled

See Also:

PROPERTY_ORGANIZATION

isActive

public Boolean isActive()

Description copied from interface: ActiveEnabled

Gets active field

Specified by:

isActive in interface ActiveEnabled

Returns:

active

See Also:

PROPERTY_ACTIVE

setActive

public void setActive(Boolean active)

Description copied from interface: ActiveEnabled

Sets active field

Specified by:

setActive in interface ActiveEnabled

See Also:

PROPERTY_ACTIVE

getCreationDate

public Date getCreationDate()

Description copied from interface: Traceable

Creation date of audit

Specified by:

getCreationDate in interface Traceable

Returns:

Date of creation

See Also:

PROPERTY_CREATIONDATE

setCreationDate

public void setCreationDate(Date creationDate)

Description copied from interface: Traceable

Creation date of audit

Specified by:

setCreationDate in interface Traceable

See Also:

PROPERTY_CREATIONDATE

getCreatedBy

public User getCreatedBy()

Description copied from interface: Traceable

Created by audit user

Specified by:

getCreatedBy in interface Traceable

Returns:

User

See Also:

PROPERTY_CREATEDBY

setCreatedBy

public void setCreatedBy(User createdBy)

Description copied from interface: Traceable

Created by audit user

Specified by:

setCreatedBy in interface Traceable

See Also:

PROPERTY_CREATEDBY

getUpdated

public Date getUpdated()

Description copied from interface: Traceable

Update date of audit

Specified by:

getUpdated in interface Traceable

Returns:

Date of update

See Also:

PROPERTY_UPDATED

setUpdated

public void setUpdated(Date updated)

Description copied from interface: Traceable

Update date of audit

Specified by:

setUpdated in interface Traceable

See Also:

PROPERTY_UPDATED

getUpdatedBy

public User getUpdatedBy()

Description copied from interface: Traceable

Update by audit user

Specified by:

getUpdatedBy in interface Traceable

Returns:

User who updated

See Also:

PROPERTY_UPDATEDBY

setUpdatedBy

public void setUpdatedBy(User updatedBy)

Description copied from interface: Traceable

Update by audit user

Specified by:

setUpdatedBy in interface Traceable

See Also:

PROPERTY_UPDATEDBY

getCurrency

public Currency getCurrency()

See Also:

PROPERTY_CURRENCY

setCurrency

public void setCurrency(Currency currency)

See Also:

PROPERTY_CURRENCY

getToCurrency

public Currency getToCurrency()

See Also:

PROPERTY_TOCURRENCY

setToCurrency

public void setToCurrency(Currency toCurrency)

See Also:

PROPERTY_TOCURRENCY

getValidFromDate

public Date getValidFromDate()

See Also:

PROPERTY_VALIDFROMDATE

setValidFromDate

public void setValidFromDate(Date validFromDate)

See Also:

PROPERTY_VALIDFROMDATE

getValidToDate

public Date getValidToDate()

See Also:

PROPERTY_VALIDTODATE

setValidToDate

public void setValidToDate(Date validToDate)

See Also:

PROPERTY_VALIDTODATE

getConversionRateType

public String getConversionRateType()

See Also:

PROPERTY_CONVERSIONRATETYPE

setConversionRateType

public void setConversionRateType(String conversionRateType)

See Also:

PROPERTY_CONVERSIONRATETYPE

getMultipleRateBy

public BigDecimal getMultipleRateBy()

See Also:

PROPERTY_MULTIPLERATEBY

setMultipleRateBy

public void setMultipleRateBy(BigDecimal multipleRateBy)

See Also:

PROPERTY_MULTIPLERATEBY

getDivideRateBy

public BigDecimal getDivideRateBy()

See Also:

PROPERTY_DIVIDERATEBY

setDivideRateBy

public void setDivideRateBy(BigDecimal divideRateBy)

See Also:

PROPERTY_DIVIDERATEBY