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/SalesRegion

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#SalesRegion


SalesRegion

The Sales Region defines the different regions where you do business. Sales Regions can be used when generating reports or calculating commissions.

To the database table (C_SalesRegion) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* C_SalesRegion_ID Mandatory
Max Length: 32
java.lang.String The Sales Region indicates a specific area of sales coverage.
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.
searchKey Value Mandatory
Max Length: 40
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.

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.
summaryLevel IsSummary Mandatory
java.lang.Boolean A summary entity represents a branch in a tree rather than an end-node. Summary entities are used for reporting and do not have own values.
salesRepresentative SalesRep_ID ADUser Indicates the sales representative responsible for the transaction that the document specifies . A valid sales representative is a business partner marked as an employee and a sales representative.
default IsDefault Mandatory
java.lang.Boolean The Default Checkbox indicates if this record will be used as a default value.


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-2019 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.sales;
 
 import java.util.Date;
 
 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;
 /**
  * Entity class for entity SalesRegion (stored in table C_SalesRegion).
  * <br>
  * Help: {@literal The Sales Region defines the different regions where you do business.  Sales Regions can be used
        when generating reports or calculating commissions.}
  * <br>
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class SalesRegion extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "C_SalesRegion";
     public static final String ENTITY_NAME = "SalesRegion";
 
     /**
      * Property id stored in column C_SalesRegion_ID in table C_SalesRegion<br>
      * Help: {@literal The Sales Region indicates a specific area of sales coverage.}
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table C_SalesRegion
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table C_SalesRegion
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column IsActive in table C_SalesRegion
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table C_SalesRegion
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column CreatedBy in table C_SalesRegion
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table C_SalesRegion
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column UpdatedBy in table C_SalesRegion
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property searchKey stored in column Value in table C_SalesRegion<br>
      * Help: {@literal 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.}
      * 
      */
     public static final String PROPERTY_SEARCHKEY = "searchKey";
 
     /**
      * Property name stored in column Name in table C_SalesRegion
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
     /**
      * Property description stored in column Description in table C_SalesRegion<br>
      * Help: {@literal A description is limited to 255 characters.}
      * 
      */
     public static final String PROPERTY_DESCRIPTION = "description";
 
     /**
      * Property summaryLevel stored in column IsSummary in table C_SalesRegion<br>
      * Help: {@literal A summary entity represents a branch in a tree rather than an end-node. Summary entities are used
        for reporting and do not have own values.}
      * 
      */
     public static final String PROPERTY_SUMMARYLEVEL = "summaryLevel";
 
     /**
      * Property salesRepresentative stored in column SalesRep_ID in table C_SalesRegion<br>
      * Help: {@literal Indicates the sales representative responsible for the transaction that  the document specifies . A
        valid sales representative is a business partner marked as an employee and a sales representative.}
      * 
      */
     public static final String PROPERTY_SALESREPRESENTATIVE = "salesRepresentative";
 
     /**
      * Property default stored in column IsDefault in table C_SalesRegion<br>
      * Help: {@literal The Default Checkbox indicates if this record will be used as a default value.}
      * 
      */
     public static final String PROPERTY_DEFAULT = "default";
 
 
     public SalesRegion() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_SUMMARYLEVEL, false);
         setDefaultValue(PROPERTY_DEFAULT, false);
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see SalesRegion#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see SalesRegion#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see SalesRegion#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see SalesRegion#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see SalesRegion#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see SalesRegion#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see SalesRegion#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see SalesRegion#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see SalesRegion#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see SalesRegion#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see SalesRegion#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see SalesRegion#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see SalesRegion#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see SalesRegion#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see SalesRegion#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see SalesRegion#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see SalesRegion#PROPERTY_SEARCHKEY
      * 
      */
     public String getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     }
     /**
      * @see SalesRegion#PROPERTY_SEARCHKEY
      * 
      */
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     }
 
     /**
      * @see SalesRegion#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see SalesRegion#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     /**
      * @see SalesRegion#PROPERTY_DESCRIPTION
      * 
      */
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
     /**
      * @see SalesRegion#PROPERTY_DESCRIPTION
      * 
      */
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     /**
      * @see SalesRegion#PROPERTY_SUMMARYLEVEL
      * 
      */
     public Boolean isSummaryLevel() {
         return (Boolean) get(PROPERTY_SUMMARYLEVEL);
     }
     /**
      * @see SalesRegion#PROPERTY_SUMMARYLEVEL
      * 
      */
     public void setSummaryLevel(Boolean summaryLevel) {
         set(PROPERTY_SUMMARYLEVEL, summaryLevel);
     }
 
     /**
      * @see SalesRegion#PROPERTY_SALESREPRESENTATIVE
      * 
      */
     public User getSalesRepresentative() {
         return (User) get(PROPERTY_SALESREPRESENTATIVE);
     }
     /**
      * @see SalesRegion#PROPERTY_SALESREPRESENTATIVE
      * 
      */
     public void setSalesRepresentative(User salesRepresentative) {
         set(PROPERTY_SALESREPRESENTATIVE, salesRepresentative);
     }
 
     /**
      * @see SalesRegion#PROPERTY_DEFAULT
      * 
      */
     public Boolean isDefault() {
         return (Boolean) get(PROPERTY_DEFAULT);
     }
     /**
      * @see SalesRegion#PROPERTY_DEFAULT
      * 
      */
     public void setDefault(Boolean deflt) {
         set(PROPERTY_DEFAULT, deflt);
     }
 
 }

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

This page has been accessed 1,319 times. This page was last modified on 12 November 2019, at 08:20. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.