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

ClientInformation

The Client Info Tab defines the details for each client. The accounting rules and high level defaults are defined here. The Calendar is used to determine if a period is open or closed.

To the database table (AD_ClientInfo) of this entity.

Back to the entity model.

Properties

Note:

Properties marked with a * are part of the Id of the Entity.
Properties marked with a # are part of the Identifier of the Entity.

Property	Column	Constraints	Type	Description
id^*	AD_Client_ID	Mandatory Max Length: 22	java.lang.String	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.
discountCalculatedFromLineAmounts	IsDiscountLineAmt	Mandatory	java.lang.Boolean	If the payment discount is calculated from line amounts only, the tax and charge amounts are not included. This is e.g. business practice in the US. If not selected the total invoice amount is used to calculate the payment discount.
calendar	C_Calendar_ID		FinancialMgmtCalendar	The Calendar uniquely identifies an accounting calendar. Multiple calendars can be used. For example you may need a standard calendar that runs from Jan 1 to Dec 31 and a fiscal calendar that runs from July 1 to June 30.
primaryAccountingSchema	C_AcctSchema1_ID		FinancialMgmtAcctSchema	An Accounting Schema defines the rules used accounting such as costing method, currency and calendar.
enableSecondAccountingSchema	Acct2_Active	Mandatory	java.lang.Boolean	The Second Accounting Schema indicates an alternate set of rules to use for generating reports.
secondAccountingSchema	C_AcctSchema2_ID		FinancialMgmtAcctSchema	An Accounting Schema defines the rules used in accounting such as costing method, currency and calendar.
enableThirdAccountingSchema	Acct3_Active	Mandatory	java.lang.Boolean	The Third Accounting Schema indicates an alternate set of rules to use for generating reports.
thirdAccountingSchema	C_AcctSchema3_ID		FinancialMgmtAcctSchema	An Accounting Schema defines the rules used in accounting such as costing method, currency and calendar
uOMForVolume	C_UOM_Volume_ID		UOM	The Standard UOM for Volume indicates the UOM to use for products referenced by volume in a document.
uOMForWeight	C_UOM_Weight_ID		UOM	The Standard UOM for Weight indicates the UOM to use for products referenced by weight in a document.
uOMForLength	C_UOM_Length_ID		UOM	The Standard UOM for Length indicates the UOM to use for products referenced by length in a document.
uOMForTime	C_UOM_Time_ID		UOM	The Standard UOM for Time indicates the UOM to use for products referenced by time in a document.
primaryTreeMenu	AD_Tree_Menu_ID		ADTree	Tree Menu
primaryTreeOrganization	AD_Tree_Org_ID		ADTree	Organization Tree
primaryTreeBPartner	AD_Tree_BPartner_ID		ADTree	Business Partner Tree
primaryTreeProject	AD_Tree_Project_ID		ADTree	Project Tree
primaryTreeSalesRegion	AD_Tree_SalesRegion_ID		ADTree
primaryTreeProduct	AD_Tree_Product_ID		ADTree	Product Tree
productForFreight	M_ProductFreight_ID		Product
templateBPartner	C_BPartnerCashTrx_ID		BusinessPartner	When creating a new Business Partner from the Business Partner Search Field (right-click: Create), the selected business partner is used as a template, e.g. to define price list, payment terms, etc.
priceList	M_PriceList_ID		PricingPriceList	Price Lists are used to determine the pricing, margin and cost of items purchased or sold.
allowNegativeStock	AllowNegativeStock	Mandatory	java.lang.Boolean	Allow negative stock
checkOrderOrganization	Checkorderorg	Mandatory	java.lang.Boolean	The checkorderorg identifies the order organization and the business partner organization and makes sure both are the same.
checkShipmentOrganization	Checkinoutorg	Mandatory	java.lang.Boolean	The Checkinoutorg identifies the shipment organization and the business partner organization and makes sure both are the same
groupInvoiceLinesInAccounting	Groupacctinvlines	Mandatory	java.lang.Boolean	Group Accounting Invoice Lines
yourCompanyMenuImage	Your_Company_Menu_Image		ADImage
yourCompanyBigImage	Your_Company_Big_Image		ADImage
yourCompanyDocumentImage	Your_Company_Document_Image		ADImage
client^#	AD_Client_ID	Mandatory	ADClient	A Client is a company or a legal entity. You cannot share data between Clients.

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.ad.system;
 
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.utility.Image;
import org.openbravo.model.ad.utility.Tree;
import org.openbravo.model.common.businesspartner.BusinessPartner;
import org.openbravo.model.common.enterprise.Organization;
import org.openbravo.model.common.plm.Product;
import org.openbravo.model.financialmgmt.accounting.coa.AcctSchema;
import org.openbravo.model.financialmgmt.calendar.Calendar;
import org.openbravo.model.pricing.pricelist.PriceList;
 
import java.lang.Boolean;
import java.lang.String;
 
import java.util.Date;
 
/**
 * Entity class for entity ClientInformation (stored in table AD_ClientInfo).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class ClientInformation extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_ClientInfo";
    public static final String ClientInformation = "ClientInformation";
    public static final String PROPERTY_ID = "id";
    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_DISCOUNTCALCULATEDFROMLINEAMOUNTS =
        "discountCalculatedFromLineAmounts";
    public static final String PROPERTY_CALENDAR = "calendar";
    public static final String PROPERTY_PRIMARYACCOUNTINGSCHEMA =
        "primaryAccountingSchema";
    public static final String PROPERTY_ENABLESECONDACCOUNTINGSCHEMA =
        "enableSecondAccountingSchema";
    public static final String PROPERTY_SECONDACCOUNTINGSCHEMA =
        "secondAccountingSchema";
    public static final String PROPERTY_ENABLETHIRDACCOUNTINGSCHEMA =
        "enableThirdAccountingSchema";
    public static final String PROPERTY_THIRDACCOUNTINGSCHEMA =
        "thirdAccountingSchema";
    public static final String PROPERTY_UOMFORVOLUME = "uOMForVolume";
    public static final String PROPERTY_UOMFORWEIGHT = "uOMForWeight";
    public static final String PROPERTY_UOMFORLENGTH = "uOMForLength";
    public static final String PROPERTY_UOMFORTIME = "uOMForTime";
    public static final String PROPERTY_PRIMARYTREEMENU = "primaryTreeMenu";
    public static final String PROPERTY_PRIMARYTREEORGANIZATION =
        "primaryTreeOrganization";
    public static final String PROPERTY_PRIMARYTREEBPARTNER =
        "primaryTreeBPartner";
    public static final String PROPERTY_PRIMARYTREEPROJECT =
        "primaryTreeProject";
    public static final String PROPERTY_PRIMARYTREESALESREGION =
        "primaryTreeSalesRegion";
    public static final String PROPERTY_PRIMARYTREEPRODUCT =
        "primaryTreeProduct";
    public static final String PROPERTY_PRODUCTFORFREIGHT = "productForFreight";
    public static final String PROPERTY_TEMPLATEBPARTNER = "templateBPartner";
    public static final String PROPERTY_PRICELIST = "priceList";
    public static final String PROPERTY_ALLOWNEGATIVESTOCK =
        "allowNegativeStock";
    public static final String PROPERTY_CHECKORDERORGANIZATION =
        "checkOrderOrganization";
    public static final String PROPERTY_CHECKSHIPMENTORGANIZATION =
        "checkShipmentOrganization";
    public static final String PROPERTY_GROUPINVOICELINESINACCOUNTING =
        "groupInvoiceLinesInAccounting";
    public static final String PROPERTY_YOURCOMPANYMENUIMAGE =
        "yourCompanyMenuImage";
    public static final String PROPERTY_YOURCOMPANYBIGIMAGE =
        "yourCompanyBigImage";
    public static final String PROPERTY_YOURCOMPANYDOCUMENTIMAGE =
        "yourCompanyDocumentImage";
    public static final String PROPERTY_CLIENT = "client";
 
    public ClientInformation() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_DISCOUNTCALCULATEDFROMLINEAMOUNTS, false);
        setDefaultValue(PROPERTY_ENABLESECONDACCOUNTINGSCHEMA, false);
        setDefaultValue(PROPERTY_ENABLETHIRDACCOUNTINGSCHEMA, false);
        setDefaultValue(PROPERTY_ALLOWNEGATIVESTOCK, true);
        setDefaultValue(PROPERTY_CHECKORDERORGANIZATION, true);
        setDefaultValue(PROPERTY_CHECKSHIPMENTORGANIZATION, true);
        setDefaultValue(PROPERTY_GROUPINVOICELINESINACCOUNTING, false);
    }
 
    @Override
    public String getEntityName() {
        return ClientInformation;
    }
 
    public String getId() {
        return (String) get(PROPERTY_ID);
    }
 
    public void setId(String id) {
        set(PROPERTY_ID, id);
    }
 
    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 Boolean isDiscountCalculatedFromLineAmounts() {
        return (Boolean) get(PROPERTY_DISCOUNTCALCULATEDFROMLINEAMOUNTS);
    }
 
    public void setDiscountCalculatedFromLineAmounts(
        Boolean discountCalculatedFromLineAmounts) {
        set(PROPERTY_DISCOUNTCALCULATEDFROMLINEAMOUNTS,
            discountCalculatedFromLineAmounts);
    }
 
    public Calendar getCalendar() {
        return (Calendar) get(PROPERTY_CALENDAR);
    }
 
    public void setCalendar(Calendar calendar) {
        set(PROPERTY_CALENDAR, calendar);
    }
 
    public AcctSchema getPrimaryAccountingSchema() {
        return (AcctSchema) get(PROPERTY_PRIMARYACCOUNTINGSCHEMA);
    }
 
    public void setPrimaryAccountingSchema(AcctSchema primaryAccountingSchema) {
        set(PROPERTY_PRIMARYACCOUNTINGSCHEMA, primaryAccountingSchema);
    }
 
    public Boolean isEnableSecondAccountingSchema() {
        return (Boolean) get(PROPERTY_ENABLESECONDACCOUNTINGSCHEMA);
    }
 
    public void setEnableSecondAccountingSchema(
        Boolean enableSecondAccountingSchema) {
        set(PROPERTY_ENABLESECONDACCOUNTINGSCHEMA, enableSecondAccountingSchema);
    }
 
    public AcctSchema getSecondAccountingSchema() {
        return (AcctSchema) get(PROPERTY_SECONDACCOUNTINGSCHEMA);
    }
 
    public void setSecondAccountingSchema(AcctSchema secondAccountingSchema) {
        set(PROPERTY_SECONDACCOUNTINGSCHEMA, secondAccountingSchema);
    }
 
    public Boolean isEnableThirdAccountingSchema() {
        return (Boolean) get(PROPERTY_ENABLETHIRDACCOUNTINGSCHEMA);
    }
 
    public void setEnableThirdAccountingSchema(
        Boolean enableThirdAccountingSchema) {
        set(PROPERTY_ENABLETHIRDACCOUNTINGSCHEMA, enableThirdAccountingSchema);
    }
 
    public AcctSchema getThirdAccountingSchema() {
        return (AcctSchema) get(PROPERTY_THIRDACCOUNTINGSCHEMA);
    }
 
    public void setThirdAccountingSchema(AcctSchema thirdAccountingSchema) {
        set(PROPERTY_THIRDACCOUNTINGSCHEMA, thirdAccountingSchema);
    }
 
    public org.openbravo.model.common.uom.UOM getUOMForVolume() {
        return (org.openbravo.model.common.uom.UOM) get(PROPERTY_UOMFORVOLUME);
    }
 
    public void setUOMForVolume(org.openbravo.model.common.uom.UOM uOMForVolume) {
        set(PROPERTY_UOMFORVOLUME, uOMForVolume);
    }
 
    public org.openbravo.model.common.uom.UOM getUOMForWeight() {
        return (org.openbravo.model.common.uom.UOM) get(PROPERTY_UOMFORWEIGHT);
    }
 
    public void setUOMForWeight(org.openbravo.model.common.uom.UOM uOMForWeight) {
        set(PROPERTY_UOMFORWEIGHT, uOMForWeight);
    }
 
    public org.openbravo.model.common.uom.UOM getUOMForLength() {
        return (org.openbravo.model.common.uom.UOM) get(PROPERTY_UOMFORLENGTH);
    }
 
    public void setUOMForLength(org.openbravo.model.common.uom.UOM uOMForLength) {
        set(PROPERTY_UOMFORLENGTH, uOMForLength);
    }
 
    public org.openbravo.model.common.uom.UOM getUOMForTime() {
        return (org.openbravo.model.common.uom.UOM) get(PROPERTY_UOMFORTIME);
    }
 
    public void setUOMForTime(org.openbravo.model.common.uom.UOM uOMForTime) {
        set(PROPERTY_UOMFORTIME, uOMForTime);
    }
 
    public Tree getPrimaryTreeMenu() {
        return (Tree) get(PROPERTY_PRIMARYTREEMENU);
    }
 
    public void setPrimaryTreeMenu(Tree primaryTreeMenu) {
        set(PROPERTY_PRIMARYTREEMENU, primaryTreeMenu);
    }
 
    public Tree getPrimaryTreeOrganization() {
        return (Tree) get(PROPERTY_PRIMARYTREEORGANIZATION);
    }
 
    public void setPrimaryTreeOrganization(Tree primaryTreeOrganization) {
        set(PROPERTY_PRIMARYTREEORGANIZATION, primaryTreeOrganization);
    }
 
    public Tree getPrimaryTreeBPartner() {
        return (Tree) get(PROPERTY_PRIMARYTREEBPARTNER);
    }
 
    public void setPrimaryTreeBPartner(Tree primaryTreeBPartner) {
        set(PROPERTY_PRIMARYTREEBPARTNER, primaryTreeBPartner);
    }
 
    public Tree getPrimaryTreeProject() {
        return (Tree) get(PROPERTY_PRIMARYTREEPROJECT);
    }
 
    public void setPrimaryTreeProject(Tree primaryTreeProject) {
        set(PROPERTY_PRIMARYTREEPROJECT, primaryTreeProject);
    }
 
    public Tree getPrimaryTreeSalesRegion() {
        return (Tree) get(PROPERTY_PRIMARYTREESALESREGION);
    }
 
    public void setPrimaryTreeSalesRegion(Tree primaryTreeSalesRegion) {
        set(PROPERTY_PRIMARYTREESALESREGION, primaryTreeSalesRegion);
    }
 
    public Tree getPrimaryTreeProduct() {
        return (Tree) get(PROPERTY_PRIMARYTREEPRODUCT);
    }
 
    public void setPrimaryTreeProduct(Tree primaryTreeProduct) {
        set(PROPERTY_PRIMARYTREEPRODUCT, primaryTreeProduct);
    }
 
    public Product getProductForFreight() {
        return (Product) get(PROPERTY_PRODUCTFORFREIGHT);
    }
 
    public void setProductForFreight(Product productForFreight) {
        set(PROPERTY_PRODUCTFORFREIGHT, productForFreight);
    }
 
    public BusinessPartner getTemplateBPartner() {
        return (BusinessPartner) get(PROPERTY_TEMPLATEBPARTNER);
    }
 
    public void setTemplateBPartner(BusinessPartner templateBPartner) {
        set(PROPERTY_TEMPLATEBPARTNER, templateBPartner);
    }
 
    public PriceList getPriceList() {
        return (PriceList) get(PROPERTY_PRICELIST);
    }
 
    public void setPriceList(PriceList priceList) {
        set(PROPERTY_PRICELIST, priceList);
    }
 
    public Boolean isAllowNegativeStock() {
        return (Boolean) get(PROPERTY_ALLOWNEGATIVESTOCK);
    }
 
    public void setAllowNegativeStock(Boolean allowNegativeStock) {
        set(PROPERTY_ALLOWNEGATIVESTOCK, allowNegativeStock);
    }
 
    public Boolean isCheckOrderOrganization() {
        return (Boolean) get(PROPERTY_CHECKORDERORGANIZATION);
    }
 
    public void setCheckOrderOrganization(Boolean checkOrderOrganization) {
        set(PROPERTY_CHECKORDERORGANIZATION, checkOrderOrganization);
    }
 
    public Boolean isCheckShipmentOrganization() {
        return (Boolean) get(PROPERTY_CHECKSHIPMENTORGANIZATION);
    }
 
    public void setCheckShipmentOrganization(Boolean checkShipmentOrganization) {
        set(PROPERTY_CHECKSHIPMENTORGANIZATION, checkShipmentOrganization);
    }
 
    public Boolean isGroupInvoiceLinesInAccounting() {
        return (Boolean) get(PROPERTY_GROUPINVOICELINESINACCOUNTING);
    }
 
    public void setGroupInvoiceLinesInAccounting(
        Boolean groupInvoiceLinesInAccounting) {
        set(PROPERTY_GROUPINVOICELINESINACCOUNTING,
            groupInvoiceLinesInAccounting);
    }
 
    public Image getYourCompanyMenuImage() {
        return (Image) get(PROPERTY_YOURCOMPANYMENUIMAGE);
    }
 
    public void setYourCompanyMenuImage(Image yourCompanyMenuImage) {
        set(PROPERTY_YOURCOMPANYMENUIMAGE, yourCompanyMenuImage);
    }
 
    public Image getYourCompanyBigImage() {
        return (Image) get(PROPERTY_YOURCOMPANYBIGIMAGE);
    }
 
    public void setYourCompanyBigImage(Image yourCompanyBigImage) {
        set(PROPERTY_YOURCOMPANYBIGIMAGE, yourCompanyBigImage);
    }
 
    public Image getYourCompanyDocumentImage() {
        return (Image) get(PROPERTY_YOURCOMPANYDOCUMENTIMAGE);
    }
 
    public void setYourCompanyDocumentImage(Image yourCompanyDocumentImage) {
        set(PROPERTY_YOURCOMPANYDOCUMENTIMAGE, yourCompanyDocumentImage);
    }
 
    public Client getClient() {
        return (Client) get(PROPERTY_CLIENT);
    }
 
    public void setClient(Client client) {
        set(PROPERTY_CLIENT, client);
    }
}

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

This page has been accessed 1,366 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.