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.
aPRMFinAccTransactionAcctVList APRM_FinAcc_Transaction_acct_v
aPRMFinaccTransactionVList APRM_Finacc_Transaction_v
aPRMFinaccTrxFullAcctVList APRM_Finacc_Trx_Full_Acct_V
businessPartnerLocationList BusinessPartnerLocation
fINFinaccTransactionList FIN_Finacc_Transaction
fINPaymentDetailVList FIN_Payment_Detail_V
fINPaymentScheduleDetailList FIN_Payment_ScheduleDetail
financialMgmtAccountingCombinationList FinancialMgmtAccountingCombination
financialMgmtAccountingFactList FinancialMgmtAccountingFact
financialMgmtAcctSchemaElementList FinancialMgmtAcctSchemaElement
financialMgmtBudgetLineList FinancialMgmtBudgetLine
financialMgmtGLJournalLineList FinancialMgmtGLJournalLine
salesCommissionLineList SalesCommissionLine


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.sales;
 
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 
 import org.openbravo.advpaymentmngt.APRM_FinaccTransactionV;
 import org.openbravo.advpaymentmngt.APRM_Finacc_Trx_Full_Acct_V;
 import org.openbravo.advpaymentmngt.FinAccTransactionAccounting;
 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.businesspartner.Location;
 import org.openbravo.model.common.enterprise.Organization;
 import org.openbravo.model.financialmgmt.accounting.AccountingFact;
 import org.openbravo.model.financialmgmt.accounting.BudgetLine;
 import org.openbravo.model.financialmgmt.accounting.coa.AccountingCombination;
 import org.openbravo.model.financialmgmt.accounting.coa.AcctSchemaElement;
 import org.openbravo.model.financialmgmt.gl.GLJournalLine;
 import org.openbravo.model.financialmgmt.payment.FIN_FinaccTransaction;
 import org.openbravo.model.financialmgmt.payment.FIN_PaymentDetailV;
 import org.openbravo.model.financialmgmt.payment.FIN_PaymentScheduleDetail;
 /**
  * Entity class for entity SalesRegion (stored in table C_SalesRegion).
  *
  * 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";
     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_SEARCHKEY = "searchKey";
     public static final String PROPERTY_NAME = "name";
     public static final String PROPERTY_DESCRIPTION = "description";
     public static final String PROPERTY_SUMMARYLEVEL = "summaryLevel";
     public static final String PROPERTY_SALESREPRESENTATIVE = "salesRepresentative";
     public static final String PROPERTY_DEFAULT = "default";
     public static final String PROPERTY_APRMFINACCTRANSACTIONACCTVLIST = "aPRMFinAccTransactionAcctVList";
     public static final String PROPERTY_APRMFINACCTRANSACTIONVLIST = "aPRMFinaccTransactionVList";
     public static final String PROPERTY_APRMFINACCTRXFULLACCTVLIST = "aPRMFinaccTrxFullAcctVList";
     public static final String PROPERTY_BUSINESSPARTNERLOCATIONLIST = "businessPartnerLocationList";
     public static final String PROPERTY_FINFINACCTRANSACTIONLIST = "fINFinaccTransactionList";
     public static final String PROPERTY_FINPAYMENTDETAILVLIST = "fINPaymentDetailVList";
     public static final String PROPERTY_FINPAYMENTSCHEDULEDETAILLIST = "fINPaymentScheduleDetailList";
     public static final String PROPERTY_FINANCIALMGMTACCOUNTINGCOMBINATIONLIST = "financialMgmtAccountingCombinationList";
     public static final String PROPERTY_FINANCIALMGMTACCOUNTINGFACTLIST = "financialMgmtAccountingFactList";
     public static final String PROPERTY_FINANCIALMGMTACCTSCHEMAELEMENTLIST = "financialMgmtAcctSchemaElementList";
     public static final String PROPERTY_FINANCIALMGMTBUDGETLINELIST = "financialMgmtBudgetLineList";
     public static final String PROPERTY_FINANCIALMGMTGLJOURNALLINELIST = "financialMgmtGLJournalLineList";
     public static final String PROPERTY_SALESCOMMISSIONLINELIST = "salesCommissionLineList";
 
     public SalesRegion() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_SUMMARYLEVEL, false);
         setDefaultValue(PROPERTY_DEFAULT, false);
         setDefaultValue(PROPERTY_APRMFINACCTRANSACTIONACCTVLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_APRMFINACCTRANSACTIONVLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_APRMFINACCTRXFULLACCTVLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_BUSINESSPARTNERLOCATIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINFINACCTRANSACTIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINPAYMENTDETAILVLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINPAYMENTSCHEDULEDETAILLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTACCOUNTINGCOMBINATIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTACCOUNTINGFACTLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTACCTSCHEMAELEMENTLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTBUDGETLINELIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_FINANCIALMGMTGLJOURNALLINELIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_SALESCOMMISSIONLINELIST, 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 getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     }
 
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     }
 
     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 Boolean isSummaryLevel() {
         return (Boolean) get(PROPERTY_SUMMARYLEVEL);
     }
 
     public void setSummaryLevel(Boolean summaryLevel) {
         set(PROPERTY_SUMMARYLEVEL, summaryLevel);
     }
 
     public User getSalesRepresentative() {
         return (User) get(PROPERTY_SALESREPRESENTATIVE);
     }
 
     public void setSalesRepresentative(User salesRepresentative) {
         set(PROPERTY_SALESREPRESENTATIVE, salesRepresentative);
     }
 
     public Boolean isDefault() {
         return (Boolean) get(PROPERTY_DEFAULT);
     }
 
     public void setDefault(Boolean deflt) {
         set(PROPERTY_DEFAULT, deflt);
     }
 
     @SuppressWarnings("unchecked")
     public List<FinAccTransactionAccounting> getAPRMFinAccTransactionAcctVList() {
       return (List<FinAccTransactionAccounting>) get(PROPERTY_APRMFINACCTRANSACTIONACCTVLIST);
     }
 
     public void setAPRMFinAccTransactionAcctVList(List<FinAccTransactionAccounting> aPRMFinAccTransactionAcctVList) {
         set(PROPERTY_APRMFINACCTRANSACTIONACCTVLIST, aPRMFinAccTransactionAcctVList);
     }
 
     @SuppressWarnings("unchecked")
     public List<APRM_FinaccTransactionV> getAPRMFinaccTransactionVList() {
       return (List<APRM_FinaccTransactionV>) get(PROPERTY_APRMFINACCTRANSACTIONVLIST);
     }
 
     public void setAPRMFinaccTransactionVList(List<APRM_FinaccTransactionV> aPRMFinaccTransactionVList) {
         set(PROPERTY_APRMFINACCTRANSACTIONVLIST, aPRMFinaccTransactionVList);
     }
 
     @SuppressWarnings("unchecked")
     public List<APRM_Finacc_Trx_Full_Acct_V> getAPRMFinaccTrxFullAcctVList() {
       return (List<APRM_Finacc_Trx_Full_Acct_V>) get(PROPERTY_APRMFINACCTRXFULLACCTVLIST);
     }
 
     public void setAPRMFinaccTrxFullAcctVList(List<APRM_Finacc_Trx_Full_Acct_V> aPRMFinaccTrxFullAcctVList) {
         set(PROPERTY_APRMFINACCTRXFULLACCTVLIST, aPRMFinaccTrxFullAcctVList);
     }
 
     @SuppressWarnings("unchecked")
     public List<Location> getBusinessPartnerLocationList() {
       return (List<Location>) get(PROPERTY_BUSINESSPARTNERLOCATIONLIST);
     }
 
     public void setBusinessPartnerLocationList(List<Location> businessPartnerLocationList) {
         set(PROPERTY_BUSINESSPARTNERLOCATIONLIST, businessPartnerLocationList);
     }
 
     @SuppressWarnings("unchecked")
     public List<FIN_FinaccTransaction> getFINFinaccTransactionList() {
       return (List<FIN_FinaccTransaction>) get(PROPERTY_FINFINACCTRANSACTIONLIST);
     }
 
     public void setFINFinaccTransactionList(List<FIN_FinaccTransaction> fINFinaccTransactionList) {
         set(PROPERTY_FINFINACCTRANSACTIONLIST, fINFinaccTransactionList);
     }
 
     @SuppressWarnings("unchecked")
     public List<FIN_PaymentDetailV> getFINPaymentDetailVList() {
       return (List<FIN_PaymentDetailV>) get(PROPERTY_FINPAYMENTDETAILVLIST);
     }
 
     public void setFINPaymentDetailVList(List<FIN_PaymentDetailV> fINPaymentDetailVList) {
         set(PROPERTY_FINPAYMENTDETAILVLIST, fINPaymentDetailVList);
     }
 
     @SuppressWarnings("unchecked")
     public List<FIN_PaymentScheduleDetail> getFINPaymentScheduleDetailList() {
       return (List<FIN_PaymentScheduleDetail>) get(PROPERTY_FINPAYMENTSCHEDULEDETAILLIST);
     }
 
     public void setFINPaymentScheduleDetailList(List<FIN_PaymentScheduleDetail> fINPaymentScheduleDetailList) {
         set(PROPERTY_FINPAYMENTSCHEDULEDETAILLIST, fINPaymentScheduleDetailList);
     }
 
     @SuppressWarnings("unchecked")
     public List<AccountingCombination> getFinancialMgmtAccountingCombinationList() {
       return (List<AccountingCombination>) get(PROPERTY_FINANCIALMGMTACCOUNTINGCOMBINATIONLIST);
     }
 
     public void setFinancialMgmtAccountingCombinationList(List<AccountingCombination> financialMgmtAccountingCombinationList) {
         set(PROPERTY_FINANCIALMGMTACCOUNTINGCOMBINATIONLIST, financialMgmtAccountingCombinationList);
     }
 
     @SuppressWarnings("unchecked")
     public List<AccountingFact> getFinancialMgmtAccountingFactList() {
       return (List<AccountingFact>) get(PROPERTY_FINANCIALMGMTACCOUNTINGFACTLIST);
     }
 
     public void setFinancialMgmtAccountingFactList(List<AccountingFact> financialMgmtAccountingFactList) {
         set(PROPERTY_FINANCIALMGMTACCOUNTINGFACTLIST, financialMgmtAccountingFactList);
     }
 
     @SuppressWarnings("unchecked")
     public List<AcctSchemaElement> getFinancialMgmtAcctSchemaElementList() {
       return (List<AcctSchemaElement>) get(PROPERTY_FINANCIALMGMTACCTSCHEMAELEMENTLIST);
     }
 
     public void setFinancialMgmtAcctSchemaElementList(List<AcctSchemaElement> financialMgmtAcctSchemaElementList) {
         set(PROPERTY_FINANCIALMGMTACCTSCHEMAELEMENTLIST, financialMgmtAcctSchemaElementList);
     }
 
     @SuppressWarnings("unchecked")
     public List<BudgetLine> getFinancialMgmtBudgetLineList() {
       return (List<BudgetLine>) get(PROPERTY_FINANCIALMGMTBUDGETLINELIST);
     }
 
     public void setFinancialMgmtBudgetLineList(List<BudgetLine> financialMgmtBudgetLineList) {
         set(PROPERTY_FINANCIALMGMTBUDGETLINELIST, financialMgmtBudgetLineList);
     }
 
     @SuppressWarnings("unchecked")
     public List<GLJournalLine> getFinancialMgmtGLJournalLineList() {
       return (List<GLJournalLine>) get(PROPERTY_FINANCIALMGMTGLJOURNALLINELIST);
     }
 
     public void setFinancialMgmtGLJournalLineList(List<GLJournalLine> financialMgmtGLJournalLineList) {
         set(PROPERTY_FINANCIALMGMTGLJOURNALLINELIST, financialMgmtGLJournalLineList);
     }
 
     @SuppressWarnings("unchecked")
     public List<CommissionLine> getSalesCommissionLineList() {
       return (List<CommissionLine>) get(PROPERTY_SALESCOMMISSIONLINELIST);
     }
 
     public void setSalesCommissionLineList(List<CommissionLine> salesCommissionLineList) {
         set(PROPERTY_SALESCOMMISSIONLINELIST, salesCommissionLineList);
     }
 
 }

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

This page has been accessed 826 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.