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

ERP 2.50:Developers Guide/Reference/Entity Model/City

City

The Cities Tab defines Cities within a Country or Region. Cities entered here are not referenced when entering the address.

To the database table (C_City) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* C_City_ID Mandatory
Max Length: 32
java.lang.String City in a 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.
abbreviation Locode Max Length: 10 java.lang.String UN/Locode is a combination of a 2-character country code and a 3-character location code, e.g. BEANR is known as the city of Antwerp (ANR) which is located in Belgium (BE).

See: http://www.unece.org/cefact/locode/service/main.htm

coordinates Coordinates Max Length: 15 java.lang.String This column contains the geographical coordinates (latitude/longitude) of the location.<p>In order to avoid unnecessary use of non-standard characters and space, the following standard presentation is used:
0000N 00000W 0000S 00000E
where the tw
postalCode Postal Max Length: 10 java.lang.String The Postal Code field identifies the postal code for this entity's address.
areaCode AreaCode Max Length: 10 java.lang.String Phone Area Code
country C_Country_ID Country The Country defines a Country. Each Country must be defined before it can be used in any document.
region C_Region_ID Region The Region identifies a unique Region for this Country.

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.common.enterprise.Organization;
 
import java.lang.Boolean;
import java.lang.String;
 
import java.util.Date;
 
/**
 * Entity class for entity City (stored in table C_City).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class City extends BaseOBObject implements Traceable, ClientEnabled,
    OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "C_City";
    public static final String City = "City";
    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_ABBREVIATION = "abbreviation";
    public static final String PROPERTY_COORDINATES = "coordinates";
    public static final String PROPERTY_POSTALCODE = "postalCode";
    public static final String PROPERTY_AREACODE = "areaCode";
    public static final String PROPERTY_COUNTRY = "country";
    public static final String PROPERTY_REGION = "region";
 
    public City() {
        setDefaultValue(PROPERTY_ACTIVE, true);
    }
 
    @Override
    public String getEntityName() {
        return City;
    }
 
    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 getAbbreviation() {
        return (String) get(PROPERTY_ABBREVIATION);
    }
 
    public void setAbbreviation(String abbreviation) {
        set(PROPERTY_ABBREVIATION, abbreviation);
    }
 
    public String getCoordinates() {
        return (String) get(PROPERTY_COORDINATES);
    }
 
    public void setCoordinates(String coordinates) {
        set(PROPERTY_COORDINATES, coordinates);
    }
 
    public String getPostalCode() {
        return (String) get(PROPERTY_POSTALCODE);
    }
 
    public void setPostalCode(String postalCode) {
        set(PROPERTY_POSTALCODE, postalCode);
    }
 
    public String getAreaCode() {
        return (String) get(PROPERTY_AREACODE);
    }
 
    public void setAreaCode(String areaCode) {
        set(PROPERTY_AREACODE, areaCode);
    }
 
    public Country getCountry() {
        return (Country) get(PROPERTY_COUNTRY);
    }
 
    public void setCountry(Country country) {
        set(PROPERTY_COUNTRY, country);
    }
 
    public Region getRegion() {
        return (Region) get(PROPERTY_REGION);
    }
 
    public void setRegion(Region region) {
        set(PROPERTY_REGION, region);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP_2.50:Developers_Guide/Reference/Entity_Model/City"

This page has been accessed 1,515 times. This page was last modified on 14 June 2011, at 11:04. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.