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

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

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


BusinessPartnerCategory

The Business Partner Group allows for the association of business partners for reporting and accounting defaults.

To the database table (C_BP_Group) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* C_BP_Group_ID Mandatory
Max Length: 32
java.lang.String A way of grouping business partners together for classification and reporting purposes. Provides a method of defining certain defaults to be used when opening new business partners.
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.
default IsDefault Mandatory
java.lang.Boolean The Default Checkbox indicates if this record will be used as a default value.
businessPartnerList BusinessPartner
businessPartnerCategoryAccountList BusinessPartnerCategoryAccount


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-2020 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.common.businesspartner;
 
 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;
 /**
  * Entity class for entity BusinessPartnerCategory (stored in table C_BP_Group).
  * <br>
  * Help: {@literal The Business Partner Group allows for the association of business partners for reporting
      *       and accounting defaults.}
  * <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 Category extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "C_BP_Group";
     public static final String ENTITY_NAME = "BusinessPartnerCategory";
 
     /**
      * Property id stored in column C_BP_Group_ID in table C_BP_Group<br>
      * Help: {@literal A way of grouping business partners together for classification and reporting purposes.
      *       Provides a method of defining certain defaults to be used when opening new business partners.}
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table C_BP_Group 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table C_BP_Group 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column IsActive in table C_BP_Group 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table C_BP_Group 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column CreatedBy in table C_BP_Group 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table C_BP_Group 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column UpdatedBy in table C_BP_Group 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property searchKey stored in column Value in table C_BP_Group<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_BP_Group 
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
     /**
      * Property description stored in column Description in table C_BP_Group<br>
      * Help: {@literal A description is limited to 255 characters.}
      * 
      */
     public static final String PROPERTY_DESCRIPTION = "description";
 
     /**
      * Property default stored in column IsDefault in table C_BP_Group<br>
      * Help: {@literal The Default Checkbox indicates if this record will be used as a default value.}
      * 
      */
     public static final String PROPERTY_DEFAULT = "default";
 
     /**
      * Property businessPartnerList stored in table C_BP_Group
      * 
      */
     public static final String PROPERTY_BUSINESSPARTNERLIST = "businessPartnerList";
 
     /**
      * Property businessPartnerCategoryAccountList stored in table C_BP_Group
      * 
      */
     public static final String PROPERTY_BUSINESSPARTNERCATEGORYACCOUNTLIST = "businessPartnerCategoryAccountList";
 
 
     public Category() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_DEFAULT, false);
         setDefaultValue(PROPERTY_BUSINESSPARTNERLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_BUSINESSPARTNERCATEGORYACCOUNTLIST, new ArrayList<Object>());
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see Category#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see Category#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see Category#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see Category#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see Category#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see Category#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see Category#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see Category#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see Category#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see Category#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see Category#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see Category#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see Category#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see Category#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see Category#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see Category#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see Category#PROPERTY_SEARCHKEY
      * 
      */
     public String getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     }
     /**
      * @see Category#PROPERTY_SEARCHKEY
      * 
      */
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     }
 
     /**
      * @see Category#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see Category#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     /**
      * @see Category#PROPERTY_DESCRIPTION
      * 
      */
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
     /**
      * @see Category#PROPERTY_DESCRIPTION
      * 
      */
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     /**
      * @see Category#PROPERTY_DEFAULT
      * 
      */
     public Boolean isDefault() {
         return (Boolean) get(PROPERTY_DEFAULT);
     }
     /**
      * @see Category#PROPERTY_DEFAULT
      * 
      */
     public void setDefault(Boolean deflt) {
         set(PROPERTY_DEFAULT, deflt);
     }
 
     /**
      * Help: {@literal The Business Partner table defines any entity with whom an organization transacts. The
      *       entity could be a customer or/and a vendor or/and an employee.
      *       Customer defines a Business Partner
      *       who is a customer of this organization.  If the Customer check box is selected then the necessary
      *       fields will display. 
      *       Vendor defines a Business Partner that is a Vendor for this Organization.  If
      *       the Vendor check box is selected the necessary fields will display.
      *       Employee defines a Business
      *       Partner who is an Employee of this organization.  If the Employee is also a Sales Representative
      *       then the check box should be selected.}<br>
      * @see BusinessPartner
      * 
      */
     @SuppressWarnings("unchecked")
     public List<BusinessPartner> getBusinessPartnerList() {
       return (List<BusinessPartner>) get(PROPERTY_BUSINESSPARTNERLIST);
     }
 
     /**
      * Help: {@literal The Business Partner table defines any entity with whom an organization transacts. The
      *       entity could be a customer or/and a vendor or/and an employee.
      *       Customer defines a Business Partner
      *       who is a customer of this organization.  If the Customer check box is selected then the necessary
      *       fields will display. 
      *       Vendor defines a Business Partner that is a Vendor for this Organization.  If
      *       the Vendor check box is selected the necessary fields will display.
      *       Employee defines a Business
      *       Partner who is an Employee of this organization.  If the Employee is also a Sales Representative
      *       then the check box should be selected.}<br>
      * @see BusinessPartner
      * 
      */
     public void setBusinessPartnerList(List<BusinessPartner> businessPartnerList) {
         set(PROPERTY_BUSINESSPARTNERLIST, businessPartnerList);
     }
 
     /**
      * Help: {@literal Defines the default accounts for any business partner that references this group.  These
      *       default values can be modified for each business partner if required.}<br>
      * @see CategoryAccounts
      * 
      */
     @SuppressWarnings("unchecked")
     public List<CategoryAccounts> getBusinessPartnerCategoryAccountList() {
       return (List<CategoryAccounts>) get(PROPERTY_BUSINESSPARTNERCATEGORYACCOUNTLIST);
     }
 
     /**
      * Help: {@literal Defines the default accounts for any business partner that references this group.  These
      *       default values can be modified for each business partner if required.}<br>
      * @see CategoryAccounts
      * 
      */
     public void setBusinessPartnerCategoryAccountList(List<CategoryAccounts> businessPartnerCategoryAccountList) {
         set(PROPERTY_BUSINESSPARTNERCATEGORYACCOUNTLIST, businessPartnerCategoryAccountList);
     }
 
 }

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

This page has been accessed 2,141 times. This page was last modified on 30 November 2020, at 01:54. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.