View source | Discuss this page | Page history | Printable version   

ERP/2.50/Developers Guide/Reference/Entity Model/CurrencyConversionRate

CurrencyConversionRate

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.

To the database table (C_Conversion_Rate) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id*# C_Conversion_Rate_ID Mandatory
Max Length: 32
java.lang.String The Conversion Rate defines the rate (multiply or divide) to use when converting a source currency to an accounting currency.
client AD_Client_ID Mandatory ADClient A Client is a company or a legal entity. You cannot share data between Clients.
organization AD_Org_ID Mandatory Organization An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations.
active IsActive Mandatory java.lang.Boolean There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:

(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions.

creationDate Created Mandatory java.util.Date The Created field indicates the date that this record was created.
createdBy CreatedBy Mandatory ADUser The Created By field indicates the user who created this record.
updated Updated Mandatory java.util.Date The Updated field indicates the date that this record was updated.
updatedBy UpdatedBy Mandatory ADUser The Updated By field indicates the user who updated this record.
currency C_Currency_ID Mandatory Currency Indicates the currency to be used when processing this document.
toCurrency C_Currency_ID_To Mandatory Currency The Currency To defines the target currency for this conversion rate.
validFromDate ValidFrom Mandatory java.util.Date The Valid From date indicates the first day of a date range
validToDate ValidTo java.util.Date The Valid To date indicates the last day of a date range
conversionRateType ConversionRateType Mandatory
Max Length: 60
java.lang.String 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.
multipleRateBy MultiplyRate Mandatory java.math.BigDecimal 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.
divideRateBy DivideRate Mandatory java.math.BigDecimal 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.

Java Entity Class

 
/*
 *************************************************************************
 * The contents of this file are subject to the Openbravo  Public  License
 * Version  1.1  (the  "License"),  being   the  Mozilla   Public  License
 * Version 1.1  with a permitted attribution clause; you may not  use this
 * file except in compliance with the License. You  may  obtain  a copy of
 * the License at http://www.openbravo.com/legal/license.html
 * Software distributed under the License  is  distributed  on  an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific  language  governing  rights  and  limitations
 * under the License.
 * The Original Code is Openbravo ERP.
 * The Initial Developer of the Original Code is Openbravo SLU
 * All portions are Copyright (C) 2008-2010 Openbravo SLU
 * All Rights Reserved.
 * Contributor(s):  ______________________________________.
 ************************************************************************
*/
package org.openbravo.model.common.currency;
 
import org.openbravo.base.structure.ActiveEnabled;
import org.openbravo.base.structure.BaseOBObject;
import org.openbravo.base.structure.ClientEnabled;
import org.openbravo.base.structure.OrganizationEnabled;
import org.openbravo.base.structure.Traceable;
import org.openbravo.model.ad.access.User;
import org.openbravo.model.ad.system.Client;
import org.openbravo.model.common.enterprise.Organization;
 
import java.lang.Boolean;
import java.lang.String;
 
import java.math.BigDecimal;
 
import java.util.Date;
 
/**
 * Entity class for entity CurrencyConversionRate (stored in table C_Conversion_Rate).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class ConversionRate extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "C_Conversion_Rate";
    public static final String CurrencyConversionRate = "CurrencyConversionRate";
    public static final String PROPERTY_ID = "id";
    public static final String PROPERTY_CLIENT = "client";
    public static final String PROPERTY_ORGANIZATION = "organization";
    public static final String PROPERTY_ACTIVE = "active";
    public static final String PROPERTY_CREATIONDATE = "creationDate";
    public static final String PROPERTY_CREATEDBY = "createdBy";
    public static final String PROPERTY_UPDATED = "updated";
    public static final String PROPERTY_UPDATEDBY = "updatedBy";
    public static final String PROPERTY_CURRENCY = "currency";
    public static final String PROPERTY_TOCURRENCY = "toCurrency";
    public static final String PROPERTY_VALIDFROMDATE = "validFromDate";
    public static final String PROPERTY_VALIDTODATE = "validToDate";
    public static final String PROPERTY_CONVERSIONRATETYPE =
        "conversionRateType";
    public static final String PROPERTY_MULTIPLERATEBY = "multipleRateBy";
    public static final String PROPERTY_DIVIDERATEBY = "divideRateBy";
 
    public ConversionRate() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_CONVERSIONRATETYPE, "S");
    }
 
    @Override
    public String getEntityName() {
        return CurrencyConversionRate;
    }
 
    public String getId() {
        return (String) get(PROPERTY_ID);
    }
 
    public void setId(String id) {
        set(PROPERTY_ID, id);
    }
 
    public Client getClient() {
        return (Client) get(PROPERTY_CLIENT);
    }
 
    public void setClient(Client client) {
        set(PROPERTY_CLIENT, client);
    }
 
    public Organization getOrganization() {
        return (Organization) get(PROPERTY_ORGANIZATION);
    }
 
    public void setOrganization(Organization organization) {
        set(PROPERTY_ORGANIZATION, organization);
    }
 
    public Boolean isActive() {
        return (Boolean) get(PROPERTY_ACTIVE);
    }
 
    public void setActive(Boolean active) {
        set(PROPERTY_ACTIVE, active);
    }
 
    public Date getCreationDate() {
        return (Date) get(PROPERTY_CREATIONDATE);
    }
 
    public void setCreationDate(Date creationDate) {
        set(PROPERTY_CREATIONDATE, creationDate);
    }
 
    public User getCreatedBy() {
        return (User) get(PROPERTY_CREATEDBY);
    }
 
    public void setCreatedBy(User createdBy) {
        set(PROPERTY_CREATEDBY, createdBy);
    }
 
    public Date getUpdated() {
        return (Date) get(PROPERTY_UPDATED);
    }
 
    public void setUpdated(Date updated) {
        set(PROPERTY_UPDATED, updated);
    }
 
    public User getUpdatedBy() {
        return (User) get(PROPERTY_UPDATEDBY);
    }
 
    public void setUpdatedBy(User updatedBy) {
        set(PROPERTY_UPDATEDBY, updatedBy);
    }
 
    public Currency getCurrency() {
        return (Currency) get(PROPERTY_CURRENCY);
    }
 
    public void setCurrency(Currency currency) {
        set(PROPERTY_CURRENCY, currency);
    }
 
    public Currency getToCurrency() {
        return (Currency) get(PROPERTY_TOCURRENCY);
    }
 
    public void setToCurrency(Currency toCurrency) {
        set(PROPERTY_TOCURRENCY, toCurrency);
    }
 
    public Date getValidFromDate() {
        return (Date) get(PROPERTY_VALIDFROMDATE);
    }
 
    public void setValidFromDate(Date validFromDate) {
        set(PROPERTY_VALIDFROMDATE, validFromDate);
    }
 
    public Date getValidToDate() {
        return (Date) get(PROPERTY_VALIDTODATE);
    }
 
    public void setValidToDate(Date validToDate) {
        set(PROPERTY_VALIDTODATE, validToDate);
    }
 
    public String getConversionRateType() {
        return (String) get(PROPERTY_CONVERSIONRATETYPE);
    }
 
    public void setConversionRateType(String conversionRateType) {
        set(PROPERTY_CONVERSIONRATETYPE, conversionRateType);
    }
 
    public BigDecimal getMultipleRateBy() {
        return (BigDecimal) get(PROPERTY_MULTIPLERATEBY);
    }
 
    public void setMultipleRateBy(BigDecimal multipleRateBy) {
        set(PROPERTY_MULTIPLERATEBY, multipleRateBy);
    }
 
    public BigDecimal getDivideRateBy() {
        return (BigDecimal) get(PROPERTY_DIVIDERATEBY);
    }
 
    public void setDivideRateBy(BigDecimal divideRateBy) {
        set(PROPERTY_DIVIDERATEBY, divideRateBy);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP/2.50/Developers_Guide/Reference/Entity_Model/CurrencyConversionRate"

This page has been accessed 2,307 times. This page was last modified on 2 July 2011, at 21:14. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.