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

Organization

The Organization Tab is used to define an Organization. Each Organization has a Key and Name and optionally a Description. When adding a new organization, you must re-login to be able to access the new organization. Please note that you will not be able to create new entities in this window if you have not set defaults for all mandatory values!

To the database table (AD_Org) 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_Org_ID	Mandatory Max Length: 32	java.lang.String	An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations.
client	AD_Client_ID	Mandatory	ADClient	A Client is a company or a legal entity. You cannot share data between Clients.
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.
organizationType	AD_Orgtype_ID	Mandatory	OrganizationType	Each organization belongs to an organization type defined in the system
allowPeriodControl	IsPeriodControlAllowed	Mandatory	java.lang.Boolean	An organization that is checked as business unit or as a legal entity can open and close a period control.
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.
ready	IsReady	Mandatory	java.lang.Boolean	While the organization is not ready, it can be moved inside the organization's tree. A not ready organization can not execute transactions.
aDRoleOrganizationList			List of ADRoleOrganization
financialMgmtPeriodControlVList			List of FinancialMgmtPeriodControlV
organizationInformationList			List of OrganizationInformation
financialMgmtInterOrgAccountsList			List of FinancialMgmtInterOrgAccounts
financialMgmtInterOrgAccountsInterOrganizationList			List of FinancialMgmtInterOrgAccounts

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.enterprise;
 
import org.openbravo.base.structure.ActiveEnabled;
import org.openbravo.base.structure.BaseOBObject;
import org.openbravo.base.structure.ClientEnabled;
import org.openbravo.base.structure.Traceable;
import org.openbravo.model.ad.access.RoleOrganization;
import org.openbravo.model.ad.access.User;
import org.openbravo.model.ad.system.Client;
import org.openbravo.model.financialmgmt.accounting.InterOrgAccounts;
import org.openbravo.model.financialmgmt.calendar.Calendar;
import org.openbravo.model.financialmgmt.calendar.PeriodControlV;
 
import java.lang.Boolean;
import java.lang.String;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 
/**
 * Entity class for entity Organization (stored in table AD_Org).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class Organization extends BaseOBObject implements Traceable,
    ClientEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Org";
    public static final String Organization = "Organization";
    public static final String PROPERTY_ID = "id";
    public static final String PROPERTY_CLIENT = "client";
    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_ORGANIZATIONTYPE = "organizationType";
    public static final String PROPERTY_ALLOWPERIODCONTROL =
        "allowPeriodControl";
    public static final String PROPERTY_CALENDAR = "calendar";
    public static final String PROPERTY_READY = "ready";
    public static final String PROPERTY_ADROLEORGANIZATIONLIST =
        "aDRoleOrganizationList";
    public static final String PROPERTY_FINANCIALMGMTPERIODCONTROLVLIST =
        "financialMgmtPeriodControlVList";
    public static final String PROPERTY_ORGANIZATIONINFORMATIONLIST =
        "organizationInformationList";
    public static final String PROPERTY_FINANCIALMGMTINTERORGACCOUNTSLIST =
        "financialMgmtInterOrgAccountsList";
    public static final String PROPERTY_FINANCIALMGMTINTERORGACCOUNTSINTERORGANIZATIONLIST =
        "financialMgmtInterOrgAccountsInterOrganizationList";
 
    public Organization() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_SUMMARYLEVEL, false);
        setDefaultValue(PROPERTY_ALLOWPERIODCONTROL, false);
        setDefaultValue(PROPERTY_READY, false);
        setDefaultValue(PROPERTY_ADROLEORGANIZATIONLIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTPERIODCONTROLVLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_ORGANIZATIONINFORMATIONLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTINTERORGACCOUNTSLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_FINANCIALMGMTINTERORGACCOUNTSINTERORGANIZATIONLIST,
            new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return Organization;
    }
 
    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 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 OrganizationType getOrganizationType() {
        return (OrganizationType) get(PROPERTY_ORGANIZATIONTYPE);
    }
 
    public void setOrganizationType(OrganizationType organizationType) {
        set(PROPERTY_ORGANIZATIONTYPE, organizationType);
    }
 
    public Boolean isAllowPeriodControl() {
        return (Boolean) get(PROPERTY_ALLOWPERIODCONTROL);
    }
 
    public void setAllowPeriodControl(Boolean allowPeriodControl) {
        set(PROPERTY_ALLOWPERIODCONTROL, allowPeriodControl);
    }
 
    public Calendar getCalendar() {
        return (Calendar) get(PROPERTY_CALENDAR);
    }
 
    public void setCalendar(Calendar calendar) {
        set(PROPERTY_CALENDAR, calendar);
    }
 
    public Boolean isReady() {
        return (Boolean) get(PROPERTY_READY);
    }
 
    public void setReady(Boolean ready) {
        set(PROPERTY_READY, ready);
    }
 
    @SuppressWarnings("unchecked")
    public List<RoleOrganization> getADRoleOrganizationList() {
        return (List<RoleOrganization>) get(PROPERTY_ADROLEORGANIZATIONLIST);
    }
 
    public void setADRoleOrganizationList(
        List<RoleOrganization> aDRoleOrganizationList) {
        set(PROPERTY_ADROLEORGANIZATIONLIST, aDRoleOrganizationList);
    }
 
    @SuppressWarnings("unchecked")
    public List<PeriodControlV> getFinancialMgmtPeriodControlVList() {
        return (List<PeriodControlV>) get(PROPERTY_FINANCIALMGMTPERIODCONTROLVLIST);
    }
 
    public void setFinancialMgmtPeriodControlVList(
        List<PeriodControlV> financialMgmtPeriodControlVList) {
        set(PROPERTY_FINANCIALMGMTPERIODCONTROLVLIST,
            financialMgmtPeriodControlVList);
    }
 
    @SuppressWarnings("unchecked")
    public List<OrganizationInformation> getOrganizationInformationList() {
        return (List<OrganizationInformation>) get(PROPERTY_ORGANIZATIONINFORMATIONLIST);
    }
 
    public void setOrganizationInformationList(
        List<OrganizationInformation> organizationInformationList) {
        set(PROPERTY_ORGANIZATIONINFORMATIONLIST, organizationInformationList);
    }
 
    @SuppressWarnings("unchecked")
    public List<InterOrgAccounts> getFinancialMgmtInterOrgAccountsList() {
        return (List<InterOrgAccounts>) get(PROPERTY_FINANCIALMGMTINTERORGACCOUNTSLIST);
    }
 
    public void setFinancialMgmtInterOrgAccountsList(
        List<InterOrgAccounts> financialMgmtInterOrgAccountsList) {
        set(PROPERTY_FINANCIALMGMTINTERORGACCOUNTSLIST,
            financialMgmtInterOrgAccountsList);
    }
 
    @SuppressWarnings("unchecked")
    public List<InterOrgAccounts> getFinancialMgmtInterOrgAccountsInterOrganizationList() {
        return (List<InterOrgAccounts>) get(PROPERTY_FINANCIALMGMTINTERORGACCOUNTSINTERORGANIZATIONLIST);
    }
 
    public void setFinancialMgmtInterOrgAccountsInterOrganizationList(
        List<InterOrgAccounts> financialMgmtInterOrgAccountsInterOrganizationList) {
        set(PROPERTY_FINANCIALMGMTINTERORGACCOUNTSINTERORGANIZATIONLIST,
            financialMgmtInterOrgAccountsInterOrganizationList);
    }
}

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

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