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

ERP/2.50/Developers Guide/Reference/Entity Model/FinancialMgmtPeriod

FinancialMgmtPeriod

The Period Tab defines a Period No, Name and Start Date for each Calendar Year. Each period begins on the defined Start Date and ends one day prior to the next period's Start Date.

To the database table (C_Period) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* C_Period_ID Mandatory
Max Length: 32
java.lang.String The Period indicates an exclusive range of dates for a calendar.
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.
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.
periodNo PeriodNo Mandatory java.lang.Long The Period No identifies a specific period for this year. Each period is defined by a start and end date. Date ranges for a calendar and year cannot overlap.
year C_Year_ID Mandatory FinancialMgmtYear The Year uniquely identifies an accounting year for a calendar.
startingDate StartDate Mandatory java.util.Date A parameter stating when a specified request will begin.
endingDate EndDate java.util.Date The End Date indicates the last date in this range.
periodType PeriodType Mandatory
Max Length: 60
java.lang.String The Period Type indicates the type (Standard or Adjustment) of period.
processNow Processing java.lang.Boolean When this field is set as 'Y' a process is being performed on this record.
closingFactAcctGroup Close_Fact_Acct_Group_ID Max Length: 32 java.lang.String Refers to the Fact_Acct_Group_ID of the closing entry
regularizationFactAcctGroup Reg_Fact_Acct_Group_ID Max Length: 32 java.lang.String Refers to the Fact_Acct_Group_ID of the regularization entry
divideupFactAcctGroup Divideup_Fact_Acct_Group_ID Max Length: 32 java.lang.String Refers to the Fact_Acct_Group_ID of the divide up entry
openFactAcctGroup Open_Fact_Acct_Group_ID Max Length: 32 java.lang.String Refers to the Open_Fact_Acct_Group_ID of the open entry
financialMgmtPeriodControlList List of FinancialMgmtPeriodControl

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.financialmgmt.calendar;
 
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;
 
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 
/**
 * Entity class for entity FinancialMgmtPeriod (stored in table C_Period).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class Period extends BaseOBObject implements Traceable, ClientEnabled,
    OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "C_Period";
    public static final String FinancialMgmtPeriod = "FinancialMgmtPeriod";
    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_NAME = "name";
    public static final String PROPERTY_PERIODNO = "periodNo";
    public static final String PROPERTY_YEAR = "year";
    public static final String PROPERTY_STARTINGDATE = "startingDate";
    public static final String PROPERTY_ENDINGDATE = "endingDate";
    public static final String PROPERTY_PERIODTYPE = "periodType";
    public static final String PROPERTY_PROCESSNOW = "processNow";
    public static final String PROPERTY_CLOSINGFACTACCTGROUP =
        "closingFactAcctGroup";
    public static final String PROPERTY_REGULARIZATIONFACTACCTGROUP =
        "regularizationFactAcctGroup";
    public static final String PROPERTY_DIVIDEUPFACTACCTGROUP =
        "divideupFactAcctGroup";
    public static final String PROPERTY_OPENFACTACCTGROUP = "openFactAcctGroup";
    public static final String PROPERTY_FINANCIALMGMTPERIODCONTROLLIST =
        "financialMgmtPeriodControlList";
 
    public Period() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_PERIODTYPE, "S");
        setDefaultValue(PROPERTY_PROCESSNOW, false);
        setDefaultValue(PROPERTY_FINANCIALMGMTPERIODCONTROLLIST,
            new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return FinancialMgmtPeriod;
    }
 
    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 getName() {
        return (String) get(PROPERTY_NAME);
    }
 
    public void setName(String name) {
        set(PROPERTY_NAME, name);
    }
 
    public Long getPeriodNo() {
        return (Long) get(PROPERTY_PERIODNO);
    }
 
    public void setPeriodNo(Long periodNo) {
        set(PROPERTY_PERIODNO, periodNo);
    }
 
    public Year getYear() {
        return (Year) get(PROPERTY_YEAR);
    }
 
    public void setYear(Year year) {
        set(PROPERTY_YEAR, year);
    }
 
    public Date getStartingDate() {
        return (Date) get(PROPERTY_STARTINGDATE);
    }
 
    public void setStartingDate(Date startingDate) {
        set(PROPERTY_STARTINGDATE, startingDate);
    }
 
    public Date getEndingDate() {
        return (Date) get(PROPERTY_ENDINGDATE);
    }
 
    public void setEndingDate(Date endingDate) {
        set(PROPERTY_ENDINGDATE, endingDate);
    }
 
    public String getPeriodType() {
        return (String) get(PROPERTY_PERIODTYPE);
    }
 
    public void setPeriodType(String periodType) {
        set(PROPERTY_PERIODTYPE, periodType);
    }
 
    public Boolean isProcessNow() {
        return (Boolean) get(PROPERTY_PROCESSNOW);
    }
 
    public void setProcessNow(Boolean processNow) {
        set(PROPERTY_PROCESSNOW, processNow);
    }
 
    public String getClosingFactAcctGroup() {
        return (String) get(PROPERTY_CLOSINGFACTACCTGROUP);
    }
 
    public void setClosingFactAcctGroup(String closingFactAcctGroup) {
        set(PROPERTY_CLOSINGFACTACCTGROUP, closingFactAcctGroup);
    }
 
    public String getRegularizationFactAcctGroup() {
        return (String) get(PROPERTY_REGULARIZATIONFACTACCTGROUP);
    }
 
    public void setRegularizationFactAcctGroup(
        String regularizationFactAcctGroup) {
        set(PROPERTY_REGULARIZATIONFACTACCTGROUP, regularizationFactAcctGroup);
    }
 
    public String getDivideupFactAcctGroup() {
        return (String) get(PROPERTY_DIVIDEUPFACTACCTGROUP);
    }
 
    public void setDivideupFactAcctGroup(String divideupFactAcctGroup) {
        set(PROPERTY_DIVIDEUPFACTACCTGROUP, divideupFactAcctGroup);
    }
 
    public String getOpenFactAcctGroup() {
        return (String) get(PROPERTY_OPENFACTACCTGROUP);
    }
 
    public void setOpenFactAcctGroup(String openFactAcctGroup) {
        set(PROPERTY_OPENFACTACCTGROUP, openFactAcctGroup);
    }
 
    @SuppressWarnings("unchecked")
    public List<PeriodControl> getFinancialMgmtPeriodControlList() {
        return (List<PeriodControl>) get(PROPERTY_FINANCIALMGMTPERIODCONTROLLIST);
    }
 
    public void setFinancialMgmtPeriodControlList(
        List<PeriodControl> financialMgmtPeriodControlList) {
        set(PROPERTY_FINANCIALMGMTPERIODCONTROLLIST,
            financialMgmtPeriodControlList);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP/2.50/Developers_Guide/Reference/Entity_Model/FinancialMgmtPeriod"

This page has been accessed 2,119 times. This page was last modified on 2 July 2011, at 21:35. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.