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/FinancialMgmtPeriodControlV

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


FinancialMgmtPeriodControlV

It displays the Period Control for the selected organization. It depends on the associated fiscal calendar.

To the database table (C_PeriodControl_V) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* C_Periodcontrol_V_ID Mandatory
Max Length: 32
java.lang.String
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.
period C_Period_ID Mandatory
FinancialMgmtPeriod The Period indicates an exclusive range of dates for a calendar.
documentCategory Docbasetype Mandatory
Max Length: 60
java.lang.String The Document Base Type identifies the base or starting point for a document. Multiple document types may share a single document base type.
periodStatus Periodstatus Max Length: 60
java.lang.String The Period Status indicates the current status for this period. For example 'Closed', 'Open', 'Never Opened'.
periodAction Periodaction Mandatory
Max Length: 60
java.lang.String The Period Action indicates the action to be taken for this period. For example 'Close Period' or 'Open Period'.
processNow Processing java.lang.Boolean When this field is set as 'Y' a process is being performed on this record.
calendar C_Calendar_ID Mandatory
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.
fiscalYear Year Mandatory
Max Length: 10
java.lang.String The Year identifies the 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.
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.


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-2019 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.model.financialmgmt.calendar;
 
 import java.util.Date;
 
 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 FinancialMgmtPeriodControlV (stored in table C_PeriodControl_V).
  * <br>
  * Help: {@literal It displays the Period Control for the selected organization. It depends on the associated fiscal
        calendar.}
  * <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 PeriodControlV extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "C_PeriodControl_V";
     public static final String ENTITY_NAME = "FinancialMgmtPeriodControlV";
 
     /**
      * Property id stored in column C_Periodcontrol_V_ID in table C_PeriodControl_V
      * @see 
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table C_PeriodControl_V
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table C_PeriodControl_V<br>
      * Help: {@literal An organization is a unit of your client or legal entity - examples are store, department. You can
        share data between organizations.}
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column Isactive in table C_PeriodControl_V
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table C_PeriodControl_V
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column Createdby in table C_PeriodControl_V
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table C_PeriodControl_V
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column Updatedby in table C_PeriodControl_V
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property period stored in column C_Period_ID in table C_PeriodControl_V<br>
      * Help: {@literal The Period indicates an exclusive range of dates for a calendar.}
      * 
      */
     public static final String PROPERTY_PERIOD = "period";
 
     /**
      * Property documentCategory stored in column Docbasetype in table C_PeriodControl_V<br>
      * Help: {@literal The Document Base Type identifies the base or starting point for a document.  Multiple document
        types may share a single document base type.}
      * 
      */
     public static final String PROPERTY_DOCUMENTCATEGORY = "documentCategory";
 
     /**
      * Property periodStatus stored in column Periodstatus in table C_PeriodControl_V<br>
      * Help: {@literal The Period Status indicates the current status for this period.  For example 'Closed', 'Open',
        'Never Opened'.}
      * 
      */
     public static final String PROPERTY_PERIODSTATUS = "periodStatus";
 
     /**
      * Property periodAction stored in column Periodaction in table C_PeriodControl_V<br>
      * Help: {@literal The Period Action indicates the action to be taken for this period.  For example 'Close Period' or
        'Open Period'.}
      * 
      */
     public static final String PROPERTY_PERIODACTION = "periodAction";
 
     /**
      * Property processNow stored in column Processing in table C_PeriodControl_V<br>
      * Help: {@literal When this field is set as 'Y' a process is being performed on this record.}
      * 
      */
     public static final String PROPERTY_PROCESSNOW = "processNow";
 
     /**
      * Property calendar stored in column C_Calendar_ID in table C_PeriodControl_V<br>
      * Help: {@literal 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.}
      * 
      */
     public static final String PROPERTY_CALENDAR = "calendar";
 
     /**
      * Property fiscalYear stored in column Year in table C_PeriodControl_V<br>
      * Help: {@literal The Year identifies the accounting year for a calendar.}
      * 
      */
     public static final String PROPERTY_FISCALYEAR = "fiscalYear";
 
     /**
      * Property startingDate stored in column Startdate in table C_PeriodControl_V<br>
      * Help: {@literal A parameter stating when a specified request will begin.}
      * 
      */
     public static final String PROPERTY_STARTINGDATE = "startingDate";
 
     /**
      * Property endingDate stored in column Enddate in table C_PeriodControl_V<br>
      * Help: {@literal The End Date indicates the last date in this range.}
      * 
      */
     public static final String PROPERTY_ENDINGDATE = "endingDate";
 
     /**
      * Property name stored in column Name in table C_PeriodControl_V
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
 
     public PeriodControlV() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_PROCESSNOW, false);
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see PeriodControlV#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see PeriodControlV#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see PeriodControlV#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see PeriodControlV#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see PeriodControlV#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see PeriodControlV#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see PeriodControlV#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see PeriodControlV#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see PeriodControlV#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_PERIOD
      * 
      */
     public Period getPeriod() {
         return (Period) get(PROPERTY_PERIOD);
     }
     /**
      * @see PeriodControlV#PROPERTY_PERIOD
      * 
      */
     public void setPeriod(Period period) {
         set(PROPERTY_PERIOD, period);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_DOCUMENTCATEGORY
      * 
      */
     public String getDocumentCategory() {
         return (String) get(PROPERTY_DOCUMENTCATEGORY);
     }
     /**
      * @see PeriodControlV#PROPERTY_DOCUMENTCATEGORY
      * 
      */
     public void setDocumentCategory(String documentCategory) {
         set(PROPERTY_DOCUMENTCATEGORY, documentCategory);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_PERIODSTATUS
      * 
      */
     public String getPeriodStatus() {
         return (String) get(PROPERTY_PERIODSTATUS);
     }
     /**
      * @see PeriodControlV#PROPERTY_PERIODSTATUS
      * 
      */
     public void setPeriodStatus(String periodStatus) {
         set(PROPERTY_PERIODSTATUS, periodStatus);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_PERIODACTION
      * 
      */
     public String getPeriodAction() {
         return (String) get(PROPERTY_PERIODACTION);
     }
     /**
      * @see PeriodControlV#PROPERTY_PERIODACTION
      * 
      */
     public void setPeriodAction(String periodAction) {
         set(PROPERTY_PERIODACTION, periodAction);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_PROCESSNOW
      * 
      */
     public Boolean isProcessNow() {
         return (Boolean) get(PROPERTY_PROCESSNOW);
     }
     /**
      * @see PeriodControlV#PROPERTY_PROCESSNOW
      * 
      */
     public void setProcessNow(Boolean processNow) {
         set(PROPERTY_PROCESSNOW, processNow);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_CALENDAR
      * 
      */
     public Calendar getCalendar() {
         return (Calendar) get(PROPERTY_CALENDAR);
     }
     /**
      * @see PeriodControlV#PROPERTY_CALENDAR
      * 
      */
     public void setCalendar(Calendar calendar) {
         set(PROPERTY_CALENDAR, calendar);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_FISCALYEAR
      * 
      */
     public String getFiscalYear() {
         return (String) get(PROPERTY_FISCALYEAR);
     }
     /**
      * @see PeriodControlV#PROPERTY_FISCALYEAR
      * 
      */
     public void setFiscalYear(String fiscalYear) {
         set(PROPERTY_FISCALYEAR, fiscalYear);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_STARTINGDATE
      * 
      */
     public Date getStartingDate() {
         return (Date) get(PROPERTY_STARTINGDATE);
     }
     /**
      * @see PeriodControlV#PROPERTY_STARTINGDATE
      * 
      */
     public void setStartingDate(Date startingDate) {
         set(PROPERTY_STARTINGDATE, startingDate);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_ENDINGDATE
      * 
      */
     public Date getEndingDate() {
         return (Date) get(PROPERTY_ENDINGDATE);
     }
     /**
      * @see PeriodControlV#PROPERTY_ENDINGDATE
      * 
      */
     public void setEndingDate(Date endingDate) {
         set(PROPERTY_ENDINGDATE, endingDate);
     }
 
     /**
      * @see PeriodControlV#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see PeriodControlV#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
 }

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

This page has been accessed 1,201 times. This page was last modified on 12 November 2019, at 08:18. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.