ERP 2.50:Developers Guide/Reference/Entity Model/Country
Country
The Country Tab defines any country in which you do business. Values entered here are referenced in location records for Business Partners.
To the database table (C_Country) of this entity.
Properties
Note:
- Properties marked with a * are part of the Id of the Entity.
- Properties marked with a # are part of the Identifier of the Entity.
Property | Column | Constraints | Type | Description |
id* | C_Country_ID | Mandatory Max Length: 32 | java.lang.String | The Country defines a Country. Each Country must be defined before it can be used in any document. |
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. |
name# | Name | Mandatory Max Length: 60 | java.lang.String | A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length. |
description | Description | Max Length: 255 | java.lang.String | A description is limited to 255 characters. |
iSOCountryCode | CountryCode | Mandatory Max Length: 2 | java.lang.String | For details - http://www.din.de/gremien/nas/nabd/iso3166ma/codlstp1.html or - http://www.unece.org/trade/rec/rec03en.htm |
hasRegions | HasRegion | Mandatory | java.lang.Boolean | The Country has Region checkbox is selected if the Country being defined is divided into regions. If this checkbox is selected, the Region Tab is accessible. |
regionName | RegionName | Max Length: 60 | java.lang.String | The Region Name defines the name that will print when this region is used in a document. |
phoneNoFormat | ExpressionPhone | Max Length: 20 | java.lang.String | Phone Format |
addressPrintFormat | DisplaySequence | Mandatory Max Length: 20 | java.lang.String | The Address Print format defines the format to be used when this address prints. The following notations are used: @C@=City @P@=Postal @A@=PostalAdd @R@=Region |
postalCodeFormat | ExpressionPostal | Max Length: 20 | java.lang.String | Postal code Format |
additionalPostalCode | HasPostal_Add | Mandatory | java.lang.Boolean | The Additional Postal Code checkbox indicates if this address uses an additional Postal Code. If it is selected an additional field displays for entry of the additional Postal Code. |
additionalPostalFormat | ExpressionPostal_Add | Max Length: 20 | java.lang.String | Additional Postal Format |
default | IsDefault | java.lang.Boolean | The Default Checkbox indicates if this record will be used as a default value. | |
language | AD_Language | ADLanguage | The Language identifies the language to use for display | |
currency | C_Currency_ID | Currency | Indicates the currency to be used when processing this document. | |
iBANLength | IBANNoDigits | java.lang.Long | Then International Bank Account Number structure do not stablish a specific length: it depends on the country. This field will define the length of the IBAN codes for that country. | |
iBANCode | IBANCountry | Max Length: 2 | java.lang.String | Then International Bank Account Number structure stablish that the first two digits will belong to the country. This country code is the one associated to a country of the application in this field. |
regionList | List of Region | |||
countryTrlList | List of CountryTrl |
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.geography; 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.ad.system.Language; import org.openbravo.model.common.currency.Currency; import org.openbravo.model.common.enterprise.Organization; import java.lang.Boolean; import java.lang.Long; import java.lang.String; import java.util.ArrayList; import java.util.Date; import java.util.List; /** * Entity class for entity Country (stored in table C_Country). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class Country extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "C_Country"; public static final String Country = "Country"; 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_NAME = "name"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_ISOCOUNTRYCODE = "iSOCountryCode"; public static final String PROPERTY_HASREGIONS = "hasRegions"; public static final String PROPERTY_REGIONNAME = "regionName"; public static final String PROPERTY_PHONENOFORMAT = "phoneNoFormat"; public static final String PROPERTY_ADDRESSPRINTFORMAT = "addressPrintFormat"; public static final String PROPERTY_POSTALCODEFORMAT = "postalCodeFormat"; public static final String PROPERTY_ADDITIONALPOSTALCODE = "additionalPostalCode"; public static final String PROPERTY_ADDITIONALPOSTALFORMAT = "additionalPostalFormat"; public static final String PROPERTY_DEFAULT = "default"; public static final String PROPERTY_LANGUAGE = "language"; public static final String PROPERTY_CURRENCY = "currency"; public static final String PROPERTY_IBANLENGTH = "iBANLength"; public static final String PROPERTY_IBANCODE = "iBANCode"; public static final String PROPERTY_REGIONLIST = "regionList"; public static final String PROPERTY_COUNTRYTRLLIST = "countryTrlList"; public Country() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_HASREGIONS, false); setDefaultValue(PROPERTY_REGIONNAME, "State"); setDefaultValue(PROPERTY_ADDITIONALPOSTALCODE, false); setDefaultValue(PROPERTY_DEFAULT, false); setDefaultValue(PROPERTY_REGIONLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_COUNTRYTRLLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return Country; } 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 String getName() { return (String) get(PROPERTY_NAME); } public void setName(String name) { set(PROPERTY_NAME, name); } public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } public String getISOCountryCode() { return (String) get(PROPERTY_ISOCOUNTRYCODE); } public void setISOCountryCode(String iSOCountryCode) { set(PROPERTY_ISOCOUNTRYCODE, iSOCountryCode); } public Boolean isHasRegions() { return (Boolean) get(PROPERTY_HASREGIONS); } public void setHasRegions(Boolean hasRegions) { set(PROPERTY_HASREGIONS, hasRegions); } public String getRegionName() { return (String) get(PROPERTY_REGIONNAME); } public void setRegionName(String regionName) { set(PROPERTY_REGIONNAME, regionName); } public String getPhoneNoFormat() { return (String) get(PROPERTY_PHONENOFORMAT); } public void setPhoneNoFormat(String phoneNoFormat) { set(PROPERTY_PHONENOFORMAT, phoneNoFormat); } public String getAddressPrintFormat() { return (String) get(PROPERTY_ADDRESSPRINTFORMAT); } public void setAddressPrintFormat(String addressPrintFormat) { set(PROPERTY_ADDRESSPRINTFORMAT, addressPrintFormat); } public String getPostalCodeFormat() { return (String) get(PROPERTY_POSTALCODEFORMAT); } public void setPostalCodeFormat(String postalCodeFormat) { set(PROPERTY_POSTALCODEFORMAT, postalCodeFormat); } public Boolean isAdditionalPostalCode() { return (Boolean) get(PROPERTY_ADDITIONALPOSTALCODE); } public void setAdditionalPostalCode(Boolean additionalPostalCode) { set(PROPERTY_ADDITIONALPOSTALCODE, additionalPostalCode); } public String getAdditionalPostalFormat() { return (String) get(PROPERTY_ADDITIONALPOSTALFORMAT); } public void setAdditionalPostalFormat(String additionalPostalFormat) { set(PROPERTY_ADDITIONALPOSTALFORMAT, additionalPostalFormat); } public Boolean isDefault() { return (Boolean) get(PROPERTY_DEFAULT); } public void setDefault(Boolean deflt) { set(PROPERTY_DEFAULT, deflt); } public Language getLanguage() { return (Language) get(PROPERTY_LANGUAGE); } public void setLanguage(Language language) { set(PROPERTY_LANGUAGE, language); } public Currency getCurrency() { return (Currency) get(PROPERTY_CURRENCY); } public void setCurrency(Currency currency) { set(PROPERTY_CURRENCY, currency); } public Long getIBANLength() { return (Long) get(PROPERTY_IBANLENGTH); } public void setIBANLength(Long iBANLength) { set(PROPERTY_IBANLENGTH, iBANLength); } public String getIBANCode() { return (String) get(PROPERTY_IBANCODE); } public void setIBANCode(String iBANCode) { set(PROPERTY_IBANCODE, iBANCode); } @SuppressWarnings("unchecked") public List<Region> getRegionList() { return (List<Region>) get(PROPERTY_REGIONLIST); } public void setRegionList(List<Region> regionList) { set(PROPERTY_REGIONLIST, regionList); } @SuppressWarnings("unchecked") public List<CountryTrl> getCountryTrlList() { return (List<CountryTrl>) get(PROPERTY_COUNTRYTRLLIST); } public void setCountryTrlList(List<CountryTrl> countryTrlList) { set(PROPERTY_COUNTRYTRLLIST, countryTrlList); } }