Class Period
- java.lang.Object
-
- org.openbravo.base.structure.BaseOBObject
-
- org.openbravo.model.financialmgmt.calendar.Period
-
- All Implemented Interfaces:
Serializable
,BaseOBObjectDef
,OBNotSingleton
,OBProvidable
,ActiveEnabled
,ClientEnabled
,DynamicEnabled
,Identifiable
,OrganizationEnabled
,Traceable
public class Period extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled
Entity class for entity FinancialMgmtPeriod (stored in table C_Period).
Help: 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.
NOTE: This class should not be instantiated directly. To instantiate this class theOBProvider
should be used.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPUTED_COLUMN_STATUS
Computed column for property status
Help: Status for the debt payment
Computed from:
(SELECT CASE WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) = 'O') THEN 'O' WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) ='C') THEN 'C' WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) ='P') THEN 'P' WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) = 'N') THEN 'N' ELSE 'M' END FROM c_periodcontrol pc WHERE pc.c_period_id = c_period_id)
static String
ENTITY_NAME
static String
PROPERTY__COMPUTEDCOLUMNS
Property _computedColumns stored in column _computedColumns in table C_Periodstatic String
PROPERTY_ACTIVE
Property active stored in column IsActive in table C_Periodstatic String
PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table C_Periodstatic String
PROPERTY_CLOSINGFACTACCTGROUP
Property closingFactAcctGroup stored in column Close_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Fact_Acct_Group_ID of the closing entrystatic String
PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table C_Periodstatic String
PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table C_Periodstatic String
PROPERTY_DIVIDEUPFACTACCTGROUP
Property divideupFactAcctGroup stored in column Divideup_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Fact_Acct_Group_ID of the divide up entrystatic String
PROPERTY_ENDINGDATE
Property endingDate stored in column EndDate in table C_Period
Help: The End Date indicates the last date in this range.static String
PROPERTY_FINANCIALMGMTPERIODCONTROLLIST
Property financialMgmtPeriodControlList stored in table C_Periodstatic String
PROPERTY_ID
Property id stored in column C_Period_ID in table C_Period
Help: The Period indicates an exclusive range of dates for a calendar.static String
PROPERTY_NAME
Property name stored in column Name in table C_Periodstatic String
PROPERTY_OPENCLOSE
Property openClose stored in column OpenClose in table C_Periodstatic String
PROPERTY_OPENFACTACCTGROUP
Property openFactAcctGroup stored in column Open_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Open_Fact_Acct_Group_ID of the open entrystatic String
PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table C_Periodstatic String
PROPERTY_PERIODNO
Property periodNo stored in column PeriodNo in table C_Period
Help: 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.static String
PROPERTY_PERIODTYPE
Property periodType stored in column PeriodType in table C_Period
Help: The Period Type indicates the type (Standard or Adjustment) of period.static String
PROPERTY_PROCESSNOW
Property processNow stored in column Processing in table C_Period
Help: When this field is set as 'Y' a process is being performed on this record.static String
PROPERTY_REGULARIZATIONFACTACCTGROUP
Property regularizationFactAcctGroup stored in column Reg_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Fact_Acct_Group_ID of the regularization entrystatic String
PROPERTY_STARTINGDATE
Property startingDate stored in column StartDate in table C_Period
Help: A parameter stating when a specified request will begin.static String
PROPERTY_UPDATED
Property updated stored in column Updated in table C_Periodstatic String
PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table C_Periodstatic String
PROPERTY_YEAR
Property year stored in column C_Year_ID in table C_Period
Help: The Year uniquely identifies an accounting year for a calendar.static String
TABLE_NAME
-
Fields inherited from class org.openbravo.base.structure.BaseOBObject
ID
-
-
Constructor Summary
Constructors Constructor Description Period()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
get(String propName)
Returns the value of theProperty
identified by the propName.Period_ComputedColumns
get_computedColumns()
Client
getClient()
Client fieldString
getClosingFactAcctGroup()
User
getCreatedBy()
Created by audit userDate
getCreationDate()
Creation date of auditString
getDivideupFactAcctGroup()
Date
getEndingDate()
String
getEntityName()
List<PeriodControl>
getFinancialMgmtPeriodControlList()
Help: The Period Control records the status of a Period (Never Opened, Opened, Closed) for each of the DocBaseTypes.String
getId()
String
getName()
String
getOpenClose()
String
getOpenFactAcctGroup()
Organization
getOrganization()
Gets organization fieldLong
getPeriodNo()
String
getPeriodType()
String
getRegularizationFactAcctGroup()
Date
getStartingDate()
String
getStatus()
Date
getUpdated()
Update date of auditUser
getUpdatedBy()
Update by audit userYear
getYear()
Boolean
isActive()
Gets active fieldBoolean
isProcessNow()
void
set_computedColumns(Period_ComputedColumns _computedColumns)
void
setActive(Boolean active)
Sets active fieldvoid
setClient(Client client)
Client fieldvoid
setClosingFactAcctGroup(String closingFactAcctGroup)
void
setCreatedBy(User createdBy)
Created by audit uservoid
setCreationDate(Date creationDate)
Creation date of auditvoid
setDivideupFactAcctGroup(String divideupFactAcctGroup)
void
setEndingDate(Date endingDate)
void
setFinancialMgmtPeriodControlList(List<PeriodControl> financialMgmtPeriodControlList)
Help: The Period Control records the status of a Period (Never Opened, Opened, Closed) for each of the DocBaseTypes.void
setId(String id)
void
setName(String name)
void
setOpenClose(String openClose)
void
setOpenFactAcctGroup(String openFactAcctGroup)
void
setOrganization(Organization organization)
Sets organization fieldvoid
setPeriodNo(Long periodNo)
void
setPeriodType(String periodType)
void
setProcessNow(Boolean processNow)
void
setRegularizationFactAcctGroup(String regularizationFactAcctGroup)
void
setStartingDate(Date startingDate)
void
setStatus(String status)
void
setUpdated(Date updated)
Update date of auditvoid
setUpdatedBy(User updatedBy)
Update by audit uservoid
setYear(Year year)
-
Methods inherited from class org.openbravo.base.structure.BaseOBObject
checkDerivedReadable, get, get, getEntity, getIdentifier, getValue, isAllowRead, isNewOBObject, isOrgClientAccessCheckEnabled, isWriteAccessCheckEnabled, set, setAccessChecks, setAllowRead, setDefaultValue, setId, setNewOBObject, setValue, toString, validate
-
-
-
-
Field Detail
-
TABLE_NAME
public static final String TABLE_NAME
- See Also:
- Constant Field Values
-
ENTITY_NAME
public static final String ENTITY_NAME
- See Also:
- Constant Field Values
-
PROPERTY_ID
public static final String PROPERTY_ID
Property id stored in column C_Period_ID in table C_Period
Help: The Period indicates an exclusive range of dates for a calendar.- See Also:
- Constant Field Values
-
PROPERTY_CLIENT
public static final String PROPERTY_CLIENT
Property client stored in column AD_Client_ID in table C_Period- See Also:
ClientEnabled
, Constant Field Values
-
PROPERTY_ORGANIZATION
public static final String PROPERTY_ORGANIZATION
Property organization stored in column AD_Org_ID in table C_Period- See Also:
OrganizationEnabled
, Constant Field Values
-
PROPERTY_ACTIVE
public static final String PROPERTY_ACTIVE
Property active stored in column IsActive in table C_Period- See Also:
ActiveEnabled
, Constant Field Values
-
PROPERTY_CREATIONDATE
public static final String PROPERTY_CREATIONDATE
Property creationDate stored in column Created in table C_Period- See Also:
Traceable
, Constant Field Values
-
PROPERTY_CREATEDBY
public static final String PROPERTY_CREATEDBY
Property createdBy stored in column CreatedBy in table C_Period- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATED
public static final String PROPERTY_UPDATED
Property updated stored in column Updated in table C_Period- See Also:
Traceable
, Constant Field Values
-
PROPERTY_UPDATEDBY
public static final String PROPERTY_UPDATEDBY
Property updatedBy stored in column UpdatedBy in table C_Period- See Also:
Traceable
, Constant Field Values
-
PROPERTY_NAME
public static final String PROPERTY_NAME
Property name stored in column Name in table C_Period- See Also:
- Constant Field Values
-
PROPERTY_PERIODNO
public static final String PROPERTY_PERIODNO
Property periodNo stored in column PeriodNo in table C_Period
Help: 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.- See Also:
- Constant Field Values
-
PROPERTY_YEAR
public static final String PROPERTY_YEAR
Property year stored in column C_Year_ID in table C_Period
Help: The Year uniquely identifies an accounting year for a calendar.- See Also:
- Constant Field Values
-
PROPERTY_STARTINGDATE
public static final String PROPERTY_STARTINGDATE
Property startingDate stored in column StartDate in table C_Period
Help: A parameter stating when a specified request will begin.- See Also:
- Constant Field Values
-
PROPERTY_ENDINGDATE
public static final String PROPERTY_ENDINGDATE
Property endingDate stored in column EndDate in table C_Period
Help: The End Date indicates the last date in this range.- See Also:
- Constant Field Values
-
PROPERTY_PERIODTYPE
public static final String PROPERTY_PERIODTYPE
Property periodType stored in column PeriodType in table C_Period
Help: The Period Type indicates the type (Standard or Adjustment) of period.- See Also:
- Constant Field Values
-
PROPERTY_PROCESSNOW
public static final String PROPERTY_PROCESSNOW
Property processNow stored in column Processing in table C_Period
Help: When this field is set as 'Y' a process is being performed on this record.- See Also:
- Constant Field Values
-
PROPERTY_CLOSINGFACTACCTGROUP
public static final String PROPERTY_CLOSINGFACTACCTGROUP
Property closingFactAcctGroup stored in column Close_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Fact_Acct_Group_ID of the closing entry- See Also:
- Constant Field Values
-
PROPERTY_REGULARIZATIONFACTACCTGROUP
public static final String PROPERTY_REGULARIZATIONFACTACCTGROUP
Property regularizationFactAcctGroup stored in column Reg_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Fact_Acct_Group_ID of the regularization entry- See Also:
- Constant Field Values
-
PROPERTY_DIVIDEUPFACTACCTGROUP
public static final String PROPERTY_DIVIDEUPFACTACCTGROUP
Property divideupFactAcctGroup stored in column Divideup_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Fact_Acct_Group_ID of the divide up entry- See Also:
- Constant Field Values
-
PROPERTY_OPENFACTACCTGROUP
public static final String PROPERTY_OPENFACTACCTGROUP
Property openFactAcctGroup stored in column Open_Fact_Acct_Group_ID in table C_Period
Help: Refers to the Open_Fact_Acct_Group_ID of the open entry- See Also:
- Constant Field Values
-
PROPERTY_OPENCLOSE
public static final String PROPERTY_OPENCLOSE
Property openClose stored in column OpenClose in table C_Period- See Also:
- Constant Field Values
-
PROPERTY__COMPUTEDCOLUMNS
public static final String PROPERTY__COMPUTEDCOLUMNS
Property _computedColumns stored in column _computedColumns in table C_Period- See Also:
- Constant Field Values
-
PROPERTY_FINANCIALMGMTPERIODCONTROLLIST
public static final String PROPERTY_FINANCIALMGMTPERIODCONTROLLIST
Property financialMgmtPeriodControlList stored in table C_Period- See Also:
- Constant Field Values
-
COMPUTED_COLUMN_STATUS
public static final String COMPUTED_COLUMN_STATUS
Computed column for property status
Help: Status for the debt payment
Computed from:
(SELECT CASE WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) = 'O') THEN 'O' WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) ='C') THEN 'C' WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) ='P') THEN 'P' WHEN (max(pc.periodstatus) = min(pc.periodstatus) AND min(pc.periodstatus) = 'N') THEN 'N' ELSE 'M' END FROM c_periodcontrol pc WHERE pc.c_period_id = c_period_id)
- See Also:
- Constant Field Values
-
-
Method Detail
-
getEntityName
public String getEntityName()
- Specified by:
getEntityName
in interfaceIdentifiable
- Specified by:
getEntityName
in classBaseOBObject
-
getId
public String getId()
- Specified by:
getId
in interfaceBaseOBObjectDef
- Specified by:
getId
in interfaceIdentifiable
- Overrides:
getId
in classBaseOBObject
- See Also:
PROPERTY_ID
-
setId
public void setId(String id)
- See Also:
PROPERTY_ID
-
getClient
public Client getClient()
Description copied from interface:ClientEnabled
Client field- Specified by:
getClient
in interfaceClientEnabled
- Returns:
- client
- See Also:
PROPERTY_CLIENT
-
setClient
public void setClient(Client client)
Description copied from interface:ClientEnabled
Client field- Specified by:
setClient
in interfaceClientEnabled
- See Also:
PROPERTY_CLIENT
-
getOrganization
public Organization getOrganization()
Description copied from interface:OrganizationEnabled
Gets organization field- Specified by:
getOrganization
in interfaceOrganizationEnabled
- Returns:
- organization
- See Also:
PROPERTY_ORGANIZATION
-
setOrganization
public void setOrganization(Organization organization)
Description copied from interface:OrganizationEnabled
Sets organization field- Specified by:
setOrganization
in interfaceOrganizationEnabled
- See Also:
PROPERTY_ORGANIZATION
-
isActive
public Boolean isActive()
Description copied from interface:ActiveEnabled
Gets active field- Specified by:
isActive
in interfaceActiveEnabled
- Returns:
- active
- See Also:
PROPERTY_ACTIVE
-
setActive
public void setActive(Boolean active)
Description copied from interface:ActiveEnabled
Sets active field- Specified by:
setActive
in interfaceActiveEnabled
- See Also:
PROPERTY_ACTIVE
-
getCreationDate
public Date getCreationDate()
Description copied from interface:Traceable
Creation date of audit- Specified by:
getCreationDate
in interfaceTraceable
- Returns:
- Date of creation
- See Also:
PROPERTY_CREATIONDATE
-
setCreationDate
public void setCreationDate(Date creationDate)
Description copied from interface:Traceable
Creation date of audit- Specified by:
setCreationDate
in interfaceTraceable
- See Also:
PROPERTY_CREATIONDATE
-
getCreatedBy
public User getCreatedBy()
Description copied from interface:Traceable
Created by audit user- Specified by:
getCreatedBy
in interfaceTraceable
- Returns:
- User
- See Also:
PROPERTY_CREATEDBY
-
setCreatedBy
public void setCreatedBy(User createdBy)
Description copied from interface:Traceable
Created by audit user- Specified by:
setCreatedBy
in interfaceTraceable
- See Also:
PROPERTY_CREATEDBY
-
getUpdated
public Date getUpdated()
Description copied from interface:Traceable
Update date of audit- Specified by:
getUpdated
in interfaceTraceable
- Returns:
- Date of update
- See Also:
PROPERTY_UPDATED
-
setUpdated
public void setUpdated(Date updated)
Description copied from interface:Traceable
Update date of audit- Specified by:
setUpdated
in interfaceTraceable
- See Also:
PROPERTY_UPDATED
-
getUpdatedBy
public User getUpdatedBy()
Description copied from interface:Traceable
Update by audit user- Specified by:
getUpdatedBy
in interfaceTraceable
- Returns:
- User who updated
- See Also:
PROPERTY_UPDATEDBY
-
setUpdatedBy
public void setUpdatedBy(User updatedBy)
Description copied from interface:Traceable
Update by audit user- Specified by:
setUpdatedBy
in interfaceTraceable
- See Also:
PROPERTY_UPDATEDBY
-
getName
public String getName()
- See Also:
PROPERTY_NAME
-
setName
public void setName(String name)
- See Also:
PROPERTY_NAME
-
getPeriodNo
public Long getPeriodNo()
- See Also:
PROPERTY_PERIODNO
-
setPeriodNo
public void setPeriodNo(Long periodNo)
- See Also:
PROPERTY_PERIODNO
-
getYear
public Year getYear()
- See Also:
PROPERTY_YEAR
-
setYear
public void setYear(Year year)
- See Also:
PROPERTY_YEAR
-
getStartingDate
public Date getStartingDate()
- See Also:
PROPERTY_STARTINGDATE
-
setStartingDate
public void setStartingDate(Date startingDate)
- See Also:
PROPERTY_STARTINGDATE
-
getEndingDate
public Date getEndingDate()
- See Also:
PROPERTY_ENDINGDATE
-
setEndingDate
public void setEndingDate(Date endingDate)
- See Also:
PROPERTY_ENDINGDATE
-
getPeriodType
public String getPeriodType()
- See Also:
PROPERTY_PERIODTYPE
-
setPeriodType
public void setPeriodType(String periodType)
- See Also:
PROPERTY_PERIODTYPE
-
isProcessNow
public Boolean isProcessNow()
- See Also:
PROPERTY_PROCESSNOW
-
setProcessNow
public void setProcessNow(Boolean processNow)
- See Also:
PROPERTY_PROCESSNOW
-
getClosingFactAcctGroup
public String getClosingFactAcctGroup()
- See Also:
PROPERTY_CLOSINGFACTACCTGROUP
-
setClosingFactAcctGroup
public void setClosingFactAcctGroup(String closingFactAcctGroup)
- See Also:
PROPERTY_CLOSINGFACTACCTGROUP
-
getRegularizationFactAcctGroup
public String getRegularizationFactAcctGroup()
- See Also:
PROPERTY_REGULARIZATIONFACTACCTGROUP
-
setRegularizationFactAcctGroup
public void setRegularizationFactAcctGroup(String regularizationFactAcctGroup)
- See Also:
PROPERTY_REGULARIZATIONFACTACCTGROUP
-
getDivideupFactAcctGroup
public String getDivideupFactAcctGroup()
- See Also:
PROPERTY_DIVIDEUPFACTACCTGROUP
-
setDivideupFactAcctGroup
public void setDivideupFactAcctGroup(String divideupFactAcctGroup)
- See Also:
PROPERTY_DIVIDEUPFACTACCTGROUP
-
getOpenFactAcctGroup
public String getOpenFactAcctGroup()
- See Also:
PROPERTY_OPENFACTACCTGROUP
-
setOpenFactAcctGroup
public void setOpenFactAcctGroup(String openFactAcctGroup)
- See Also:
PROPERTY_OPENFACTACCTGROUP
-
getOpenClose
public String getOpenClose()
- See Also:
PROPERTY_OPENCLOSE
-
setOpenClose
public void setOpenClose(String openClose)
- See Also:
PROPERTY_OPENCLOSE
-
getStatus
public String getStatus()
- See Also:
COMPUTED_COLUMN_STATUS
-
setStatus
public void setStatus(String status)
- See Also:
COMPUTED_COLUMN_STATUS
-
get_computedColumns
public Period_ComputedColumns get_computedColumns()
- See Also:
PROPERTY__COMPUTEDCOLUMNS
-
set_computedColumns
public void set_computedColumns(Period_ComputedColumns _computedColumns)
- See Also:
PROPERTY__COMPUTEDCOLUMNS
-
getFinancialMgmtPeriodControlList
public List<PeriodControl> getFinancialMgmtPeriodControlList()
Help: The Period Control records the status of a Period (Never Opened, Opened, Closed) for each of the DocBaseTypes.- See Also:
PeriodControl
-
setFinancialMgmtPeriodControlList
public void setFinancialMgmtPeriodControlList(List<PeriodControl> financialMgmtPeriodControlList)
Help: The Period Control records the status of a Period (Never Opened, Opened, Closed) for each of the DocBaseTypes.- See Also:
PeriodControl
-
get
public Object get(String propName)
Description copied from class:BaseOBObject
Returns the value of theProperty
identified by the propName. This method does security checking. If a security violation occurs then a OBSecurityException is thrown.- Specified by:
get
in interfaceBaseOBObjectDef
- Specified by:
get
in interfaceDynamicEnabled
- Overrides:
get
in classBaseOBObject
- Parameters:
propName
- the name of theProperty
for which the value is requested- See Also:
BaseOBObject.get(String, Language)
-
-