View source | Discuss this page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Add page
Show collection (0 pages)
Collections help

Search

ERP/3.0/Developers Guide/Reference/Entity Model/Region

This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
Back button.png   Back to ERP/3.0/Developers_Guide/Reference/Entity_Model#Region


Region

The Region Tab defines a Region within a Country. This tab is enabled only if the Has Region checkbox is selected for the Country.

To the database table (C_Region) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* C_Region_ID Mandatory
Max Length: 32
java.lang.String The Region identifies a unique Region for this Country.
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.
country C_Country_ID Mandatory
Country The Country defines a Country. Each Country must be defined before it can be used in any document.
default IsDefault java.lang.Boolean The Default Checkbox indicates if this record will be used as a default value.
searchKey Value Max Length: 2
java.lang.String A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order).

Usually, company's internal identifiers for various records (products, customers, etc) are stored here.

cityList City
financialMgmtTaxRateList FinancialMgmtTaxRate
financialMgmtTaxRateDestinationRegionList FinancialMgmtTaxRate
financialMgmtTaxZoneFromRegionList FinancialMgmtTaxZone
financialMgmtTaxZoneDestinationRegionList FinancialMgmtTaxZone
locationList Location
shippingShippingCompanyFreightList ShippingShippingCompanyFreight
shippingShippingCompanyFreightDestinationRegionList ShippingShippingCompanyFreight


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-2014 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.common.geography;
 
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 
 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 org.openbravo.model.financialmgmt.tax.TaxRate;
 import org.openbravo.model.financialmgmt.tax.TaxZone;
 import org.openbravo.model.shipping.ShippingCompanyFreight;
 /**
  * Entity class for entity Region (stored in table C_Region).
  *
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class Region extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "C_Region";
     public static final String ENTITY_NAME = "Region";
     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_COUNTRY = "country";
     public static final String PROPERTY_DEFAULT = "default";
     public static final String PROPERTY_SEARCHKEY = "searchKey";
     public static final String PROPERTY_CITYLIST = "cityList";
     public static final String PROPERTY_FINANCIALMGMTTAXRATELIST = "financialMgmtTaxRateList";
     public static final String PROPERTY_FINANCIALMGMTTAXRATEDESTINATIONREGIONLIST = "financialMgmtTaxRateDestinationRegionList";
     public static final String PROPERTY_FINANCIALMGMTTAXZONEFROMREGIONLIST = "financialMgmtTaxZoneFromRegionList";
     public static final String PROPERTY_FINANCIALMGMTTAXZONEDESTINATIONREGIONLIST = "financialMgmtTaxZoneDestinationRegionList";
     public static final String PROPERTY_LOCATIONLIST = "locationList";
     public static final String PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTLIST = "shippingShippingCompanyFreightList";
     public static final String PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTDESTINATIONREGIONLIST = "shippingShippingCompanyFreightDestinationRegionList";
 
     public Region() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_DEFAULT, false);
         setDefaultValue(PROPERTY_CITYLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTTAXRATELIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTTAXRATEDESTINATIONREGIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTTAXZONEFROMREGIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTTAXZONEDESTINATIONREGIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_LOCATIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTDESTINATIONREGIONLIST, new ArrayList<Object>());
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     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 Country getCountry() {
         return (Country) get(PROPERTY_COUNTRY);
     }
 
     public void setCountry(Country country) {
         set(PROPERTY_COUNTRY, country);
     }
 
     public Boolean isDefault() {
         return (Boolean) get(PROPERTY_DEFAULT);
     }
 
     public void setDefault(Boolean deflt) {
         set(PROPERTY_DEFAULT, deflt);
     }
 
     public String getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     }
 
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     }
 
     @SuppressWarnings("unchecked")
     public List<City> getCityList() {
       return (List<City>) get(PROPERTY_CITYLIST);
     }
 
     public void setCityList(List<City> cityList) {
         set(PROPERTY_CITYLIST, cityList);
     }
 
     @SuppressWarnings("unchecked")
     public List<TaxRate> getFinancialMgmtTaxRateList() {
       return (List<TaxRate>) get(PROPERTY_FINANCIALMGMTTAXRATELIST);
     }
 
     public void setFinancialMgmtTaxRateList(List<TaxRate> financialMgmtTaxRateList) {
         set(PROPERTY_FINANCIALMGMTTAXRATELIST, financialMgmtTaxRateList);
     }
 
     @SuppressWarnings("unchecked")
     public List<TaxRate> getFinancialMgmtTaxRateDestinationRegionList() {
       return (List<TaxRate>) get(PROPERTY_FINANCIALMGMTTAXRATEDESTINATIONREGIONLIST);
     }
 
     public void setFinancialMgmtTaxRateDestinationRegionList(List<TaxRate> financialMgmtTaxRateDestinationRegionList) {
         set(PROPERTY_FINANCIALMGMTTAXRATEDESTINATIONREGIONLIST, financialMgmtTaxRateDestinationRegionList);
     }
 
     @SuppressWarnings("unchecked")
     public List<TaxZone> getFinancialMgmtTaxZoneFromRegionList() {
       return (List<TaxZone>) get(PROPERTY_FINANCIALMGMTTAXZONEFROMREGIONLIST);
     }
 
     public void setFinancialMgmtTaxZoneFromRegionList(List<TaxZone> financialMgmtTaxZoneFromRegionList) {
         set(PROPERTY_FINANCIALMGMTTAXZONEFROMREGIONLIST, financialMgmtTaxZoneFromRegionList);
     }
 
     @SuppressWarnings("unchecked")
     public List<TaxZone> getFinancialMgmtTaxZoneDestinationRegionList() {
       return (List<TaxZone>) get(PROPERTY_FINANCIALMGMTTAXZONEDESTINATIONREGIONLIST);
     }
 
     public void setFinancialMgmtTaxZoneDestinationRegionList(List<TaxZone> financialMgmtTaxZoneDestinationRegionList) {
         set(PROPERTY_FINANCIALMGMTTAXZONEDESTINATIONREGIONLIST, financialMgmtTaxZoneDestinationRegionList);
     }
 
     @SuppressWarnings("unchecked")
     public List<Location> getLocationList() {
       return (List<Location>) get(PROPERTY_LOCATIONLIST);
     }
 
     public void setLocationList(List<Location> locationList) {
         set(PROPERTY_LOCATIONLIST, locationList);
     }
 
     @SuppressWarnings("unchecked")
     public List<ShippingCompanyFreight> getShippingShippingCompanyFreightList() {
       return (List<ShippingCompanyFreight>) get(PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTLIST);
     }
 
     public void setShippingShippingCompanyFreightList(List<ShippingCompanyFreight> shippingShippingCompanyFreightList) {
         set(PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTLIST, shippingShippingCompanyFreightList);
     }
 
     @SuppressWarnings("unchecked")
     public List<ShippingCompanyFreight> getShippingShippingCompanyFreightDestinationRegionList() {
       return (List<ShippingCompanyFreight>) get(PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTDESTINATIONREGIONLIST);
     }
 
     public void setShippingShippingCompanyFreightDestinationRegionList(List<ShippingCompanyFreight> shippingShippingCompanyFreightDestinationRegionList) {
         set(PROPERTY_SHIPPINGSHIPPINGCOMPANYFREIGHTDESTINATIONREGIONLIST, shippingShippingCompanyFreightDestinationRegionList);
     }
 
 }

Retrieved from "http://wiki.openbravo.com/wiki/ERP/3.0/Developers_Guide/Reference/Entity_Model/Region"

This page has been accessed 792 times. This page was last modified on 5 August 2014, at 13:56. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.