/******************************************************************************
* Product: Adempiere ERP & CRM Smart Business Solution *
* Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved. *
* This program is free software; you can redistribute it and/or modify it *
* under the terms version 2 of the GNU General Public License as published *
* by the Free Software Foundation. This program is distributed in the hope *
* that it will be useful, but WITHOUT ANY WARRANTY; without even the implied *
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
* See the GNU General Public License for more details. *
* You should have received a copy of the GNU General Public License along *
* with this program; if not, write to the Free Software Foundation, Inc., *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *
* For the text or an alternative of this public license, you may reach us *
* ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA *
* or via info@compiere.org or http://www.compiere.org/license.html *
*****************************************************************************/
package org.compiere.model;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;
import java.util.logging.Level;
import org.adempiere.exceptions.DBException;
import org.adempiere.exceptions.PeriodClosedException;
import org.compiere.util.CLogger;
import org.compiere.util.DB;
import org.compiere.util.DisplayType;
import org.compiere.util.Env;
import org.compiere.util.TimeUtil;
import org.compiere.util.Util;
import org.idempiere.cache.ImmutableIntPOCache;
import org.idempiere.cache.ImmutablePOSupport;
/**
* Calendar Period Model
*
* @author Jorg Janke
* @version $Id: MPeriod.java,v 1.4 2006/07/30 00:51:05 jjanke Exp $
*
* @author Teo Sarca, SC ARHIPAC SERVICE SRL
* BF [ 1779438 ] Minor auto period control bug
* BF [ 1893486 ] Auto Period Control return that period is always open
*
* @author victor.perez@e-evolution.com, e-Evolution http://www.e-evolution.com
* FR [ 2520591 ] Support multiples calendar for Org
* @see https://sourceforge.net/p/adempiere/feature-requests/631/
*/
public class MPeriod extends X_C_Period implements ImmutablePOSupport
{
/**
* generated serial id
*/
private static final long serialVersionUID = -2625074973303489939L;
/**
* Get Period from Cache (immutable)
* @param C_Period_ID id
* @return MPeriod
*/
public static MPeriod get (int C_Period_ID)
{
return get(Env.getCtx(), C_Period_ID);
}
/**
* Get Period from Cache (immutable)
* @param ctx context
* @param C_Period_ID id
* @return MPeriod
*/
public static MPeriod get (Properties ctx, int C_Period_ID)
{
if (C_Period_ID <= 0)
return null;
//
Integer key = Integer.valueOf(C_Period_ID);
MPeriod retValue = s_cache.get (ctx, key, e -> new MPeriod(ctx, e));
if (retValue != null)
return retValue;
//
retValue = new MPeriod (ctx, C_Period_ID, null);
if (retValue.get_ID () == C_Period_ID)
{
s_cache.put (key, retValue, e -> new MPeriod(Env.getCtx(), e));
return retValue;
}
return null;
} // get
/**
* Find standard Period of DateAcct based on Client Calendar
* @param ctx context
* @param DateAcct date
* @return active Period or null
* @deprecated
*/
@Deprecated
public static MPeriod get (Properties ctx, Timestamp DateAcct)
{
return get(ctx, DateAcct, 0, null);
} // get
/**
* Find standard Period of DateAcct based on Client Calendar
* @param ctx context
* @param DateAcct date
* @param AD_Org_ID Organization
* @return active Period or null
*/
public static MPeriod get (Properties ctx, Timestamp DateAcct, int AD_Org_ID, String trxName)
{
if (DateAcct == null)
return null;
int C_Calendar_ID = getC_Calendar_ID(ctx,AD_Org_ID);
return findByCalendar(ctx, DateAcct, C_Calendar_ID, trxName);
} // get
@Deprecated
public static MPeriod get (Properties ctx, Timestamp DateAcct, int AD_Org_ID)
{
return get(ctx, DateAcct, AD_Org_ID, null);
}
/**
* Get updateable copy of MPeriod from cache
* @param ctx
* @param C_Period_ID
* @param trxName
* @return MPeriod
*/
public static MPeriod getCopy(Properties ctx, int C_Period_ID, String trxName)
{
MPeriod period = get(C_Period_ID);
if (period != null)
period = new MPeriod(ctx, period, trxName);
return period;
}
/**
* @param ctx
* @param DateAcct
* @param C_Calendar_ID
* @return MPeriod
* @deprecated
*/
@Deprecated
public static MPeriod findByCalendar(Properties ctx, Timestamp DateAcct, int C_Calendar_ID) {
return findByCalendar(ctx, DateAcct, C_Calendar_ID, null);
}
/**
* Find standard Period of DateAcct
* @param ctx
* @param DateAcct
* @param C_Calendar_ID
* @param trxName
* @return MPeriod or null
*/
public static MPeriod findByCalendar(Properties ctx, Timestamp DateAcct, int C_Calendar_ID, String trxName) {
int AD_Client_ID = Env.getAD_Client_ID(ctx);
// Search in Cache first
MPeriod[] it = s_cache.values().toArray(new MPeriod[0]);
for (MPeriod period : it)
{
if (period.getC_Calendar_ID() == C_Calendar_ID && period.isStandardPeriod() && period.isInPeriod(DateAcct)
&& period.getAD_Client_ID() == AD_Client_ID) // globalqss - CarlosRuiz - Fix [ 1820810 ] Wrong Period Assigned to Fact_Acct
return period;
}
// Get it from DB
MPeriod retValue = null;
String sql = "SELECT * "
+ "FROM C_Period "
+ "WHERE C_Year_ID IN "
+ "(SELECT C_Year_ID FROM C_Year WHERE C_Calendar_ID= ?)"
+ " AND ? BETWEEN TRUNC(StartDate) AND TRUNC(EndDate)"
+ " AND IsActive=? AND PeriodType=?";
PreparedStatement pstmt = null;
ResultSet rs = null;
try
{
pstmt = DB.prepareStatement(sql, trxName);
pstmt.setInt (1, C_Calendar_ID);
pstmt.setTimestamp (2, TimeUtil.getDay(DateAcct));
pstmt.setString(3, "Y");
pstmt.setString(4, "S");
rs = pstmt.executeQuery();
while (rs.next())
{
MPeriod period = new MPeriod(ctx, rs, trxName);
Integer key = Integer.valueOf(period.getC_Period_ID());
s_cache.put (key, period);
if (period.isStandardPeriod())
retValue = period;
}
}
catch (SQLException e)
{
s_log.log(Level.SEVERE, "DateAcct=" + DateAcct, e);
}
finally
{
DB.close(rs, pstmt);
rs = null; pstmt = null;
}
if (retValue == null)
if (s_log.isLoggable(Level.INFO)) s_log.info("No Standard Period for " + DateAcct
+ " (AD_Client_ID=" + AD_Client_ID + ")");
return retValue;
}
/**
* Find valid standard Period of DateAcct based on Client Calendar
* @param ctx context
* @param DateAcct date
* @return C_Period_ID or 0
* @deprecated
*/
@Deprecated
public static int getC_Period_ID (Properties ctx, Timestamp DateAcct)
{
MPeriod period = get (ctx, DateAcct, 0, null);
if (period == null)
return 0;
return period.getC_Period_ID();
} // getC_Period_ID
/**
* Find valid standard Period of DateAcct based on Client Calendar
* @param ctx context
* @param DateAcct date
* @param AD_Org_ID Organization
* @return C_Period_ID or 0
*/
public static int getC_Period_ID (Properties ctx, Timestamp DateAcct, int AD_Org_ID)
{
MPeriod period = get (ctx, DateAcct, AD_Org_ID, null);
if (period == null)
return 0;
return period.getC_Period_ID();
} // getC_Period_ID
/**
* Is standard Period Open for Document Base Type
* @param ctx context
* @param DateAcct date
* @param DocBaseType base type
* @return true if open
* @deprecated
*/
@Deprecated
public static boolean isOpen (Properties ctx, Timestamp DateAcct, String DocBaseType)
{
return isOpen(ctx, DateAcct,DocBaseType, 0 );
} // isOpen
/**
* Is standard Period Open for Document Base Type
* @param ctx context
* @param DateAcct date
* @param DocBaseType base type (X_C_DocType.DOCBASETYPE_*)
* @param AD_Org_ID Organization
* @return true if open
*/
public static boolean isOpen(Properties ctx, Timestamp DateAcct, String DocBaseType, int AD_Org_ID)
{
return isOpen(ctx, DateAcct, DocBaseType, AD_Org_ID, false);
}
/**
* Is standard Period Open for Document Base Type
* @param ctx context
* @param DateAcct date
* @param DocBaseType base type (X_C_DocType.DOCBASETYPE_*)
* @param AD_Org_ID Organization
* @param forPosting - true to check if the period is open for posting, false is for DocAction
* @return true if open
*/
public static boolean isOpen (Properties ctx, Timestamp DateAcct, String DocBaseType, int AD_Org_ID, boolean forPosting)
{
if (DateAcct == null)
{
s_log.warning("No DateAcct");
return false;
}
if (DocBaseType == null)
{
s_log.warning("No DocBaseType");
return false;
}
MPeriod period = MPeriod.get (ctx, DateAcct, AD_Org_ID, null);
if (period == null)
{
s_log.warning("No Period for " + DateAcct + " (" + DocBaseType + ")");
return false;
}
boolean open = period.isOpen(DocBaseType, DateAcct, forPosting);
if (!open)
s_log.warning(period.getName()
+ ": Not open for " + DocBaseType + " (" + DateAcct + ")");
return open;
} // isOpen
/**
* Is standard Period Open - based on tableID+recordID (for IDEMPIERE-2392)
* @param ctx context
* @param tableID
* @param recordID
* @param trxName
* @return true if open
*/
public static boolean isOpen(Properties ctx, int tableID, int recordID, String trxName) {
return isOpen (ctx, tableID, recordID, trxName, false);
}
/**
* Is standard Period Open - based on tableID+recordID (for IDEMPIERE-2392)
* @param ctx context
* @param tableID
* @param recordID
* @param trxName
* @param forPosting - true to check if the period is open for posting, false is for DocAction
* @return true if open
*/
public static boolean isOpen (Properties ctx, int tableID, int recordID, String trxName, boolean forPosting) {
MTable table = MTable.get(ctx, tableID);
PO po = table.getPO(recordID, trxName);
// obtain DateAcct
int idxdate = -1;
if ( tableID == MInventory.Table_ID
|| tableID == MMovement.Table_ID
|| tableID == MProduction.Table_ID
|| tableID == MProjectIssue.Table_ID) {
idxdate = po.get_ColumnIndex("MovementDate");
} else if ( tableID == MRequisition.Table_ID) {
idxdate = po.get_ColumnIndex("DateDoc");
} else if ( tableID == MAllocationHdr.Table_ID
|| tableID == MMatchInv.Table_ID
|| tableID == MMatchPO.Table_ID) {
idxdate = po.get_ColumnIndex("DateTrx");
} else {
idxdate = po.get_ColumnIndex("DateAcct");
}
if (idxdate < 0) {
if (s_log.isLoggable(Level.INFO)) s_log.info("Could not find DateAcct for " + table.getTableName());
return true;
}
Timestamp dateAcct = null;
Object objts = po.get_Value(idxdate);
if (objts != null && objts instanceof Timestamp) {
dateAcct = (Timestamp) objts;
} else {
s_log.warning("Could not find DateAcct (null or not Timestamp) for " + table.getTableName());
return true;
}
// obtain DocBaseType
String docBaseType = null;
int idxdoctype = po.get_ColumnIndex("C_DocType_ID");
if (idxdoctype < 0) {
if (tableID == MInventory.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_MaterialPhysicalInventory;
} else if (tableID == MRequisition.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_PurchaseRequisition;
} else if (tableID == MAllocationHdr.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_PaymentAllocation;
} else if (tableID == MMatchInv.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_MatchInvoice;
} else if (tableID == MMatchPO.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_MatchPO;
} else if ( tableID == MAssetAddition.Table_ID
|| tableID == MAssetReval.Table_ID
|| tableID == MAssetTransfer.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_GLJournal;
} else if ( tableID == MAssetDisposed.Table_ID
|| tableID == MDepreciationExp.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_GLDocument; // seems like a bug of fixed assets - must use GLJournal instead of GLDocument?
} else if (tableID == MProjectIssue.Table_ID) {
docBaseType = MDocType.DOCBASETYPE_ProjectIssue;
} else {
s_log.warning("Could not find C_DocType_ID for " + table.getTableName());
return true;
}
} else {
Integer doctypeID = null;
Object objint = po.get_Value(idxdoctype);
if (objint != null && objint instanceof Integer) {
doctypeID = (Integer) objint;
} else {
s_log.warning("Could not find C_DocType_ID (null or not Integer) for " + table.getTableName());
return true;
}
if (doctypeID == 0 && (tableID == MOrder.Table_ID || tableID == MInvoice.Table_ID)) {
idxdoctype = po.get_ColumnIndex("C_DocTypeTarget_ID");
objint = po.get_Value(idxdoctype);
if (objint != null && objint instanceof Integer) {
doctypeID = (Integer) objint;
}
}
MDocType dt = MDocType.get(ctx, doctypeID);
docBaseType = dt.getDocBaseType();
}
if (Util.isEmpty(docBaseType)) {
s_log.warning("Could not find DocBaseType for " + table.getTableName());
return true;
}
// obtain AD_Org_ID
int orgID = 0;
int idxorg = po.get_ColumnIndex("AD_Org_ID");
if (idxorg < 0) {
s_log.warning("Could not find AD_Org_ID for " + table.getTableName());
} else {
orgID = po.get_ValueAsInt(idxorg);
}
if (tableID == MJournal.Table_ID || tableID == MJournalBatch.Table_ID) {
// special case for journal that has direct period
int periodID = po.get_ValueAsInt("C_Period_ID");
MPeriod period = MPeriod.get(ctx, periodID);
boolean open = period.isOpen(docBaseType, dateAcct, forPosting);
if (!open)
s_log.warning(period.getName() + ": Not open for " + docBaseType + " (" + dateAcct + ")");
return open;
}
return isOpen(ctx, dateAcct, docBaseType, orgID, forPosting);
} // isOpen
/**
* Find first Year Period of DateAcct based on Client Calendar
* @param ctx context
* @param DateAcct date
* @return active first Period
* @deprecated
*/
@Deprecated
public static MPeriod getFirstInYear (Properties ctx, Timestamp DateAcct)
{
return getFirstInYear(ctx , DateAcct, 0);
} // getFirstInYear
/**
* Find first Year Period of DateAcct based on Client Calendar
* @param ctx context
* @param DateAcct date
* @param AD_Org_ID organization
* @return active first Period
*/
public static MPeriod getFirstInYear (Properties ctx, Timestamp DateAcct, int AD_Org_ID)
{
MPeriod retValue = null;
int C_Calendar_ID = MPeriod.get(ctx, DateAcct, AD_Org_ID, null).getC_Calendar_ID();
String sql = "SELECT * "
+ "FROM C_Period "
+ "WHERE C_Year_ID IN "
+ "(SELECT p.C_Year_ID "
+ "FROM C_Year y"
+ " INNER JOIN C_Period p ON (y.C_Year_ID=p.C_Year_ID) "
+ "WHERE y.C_Calendar_ID=?"
+ " AND ? BETWEEN StartDate AND EndDate)"
+ " AND IsActive=? AND PeriodType=? "
+ "ORDER BY StartDate";
PreparedStatement pstmt = null;
ResultSet rs = null;
try
{
pstmt = DB.prepareStatement(sql, null);
pstmt.setInt (1, C_Calendar_ID);
pstmt.setTimestamp (2, DateAcct);
pstmt.setString (3, "Y");
pstmt.setString (4, "S");
rs = pstmt.executeQuery();
if (rs.next()) // first only
retValue = new MPeriod(ctx, rs, null);
}
catch (SQLException e)
{
s_log.log(Level.SEVERE, sql, e);
}
finally
{
DB.close(rs, pstmt);
rs = null; pstmt = null;
}
return retValue;
} // getFirstInYear
/** Cache */
private static ImmutableIntPOCache s_cache = new ImmutableIntPOCache(Table_Name, 10);
/** Logger */
private static CLogger s_log = CLogger.getCLogger (MPeriod.class);
/** Calendar */
private int m_C_Calendar_ID = 0;
/**
* UUID based Constructor
* @param ctx Context
* @param C_Period_UU UUID key
* @param trxName Transaction
*/
public MPeriod(Properties ctx, String C_Period_UU, String trxName) {
super(ctx, C_Period_UU, trxName);
if (Util.isEmpty(C_Period_UU))
setInitialDefaults();
}
/**
* Standard Constructor
* @param ctx context
* @param C_Period_ID id
* @param trxName transaction
*/
public MPeriod (Properties ctx, int C_Period_ID, String trxName)
{
super (ctx, C_Period_ID, trxName);
if (C_Period_ID == 0)
setInitialDefaults();
} // MPeriod
/**
* Set the initial defaults for a new record
*/
private void setInitialDefaults() {
setPeriodType (PERIODTYPE_StandardCalendarPeriod);
}
/**
* Load Constructor
* @param ctx context
* @param rs result set
* @param trxName transaction
*/
public MPeriod (Properties ctx, ResultSet rs, String trxName)
{
super(ctx, rs, trxName);
} // MPeriod
/**
* Parent constructor
* @param year year
* @param PeriodNo no
* @param name name
* @param startDate start
* @param endDate end
*/
public MPeriod (MYear year, int PeriodNo, String name,
Timestamp startDate,Timestamp endDate)
{
this (year.getCtx(), 0, year.get_TrxName());
setClientOrg(year);
setC_Year_ID(year.getC_Year_ID());
setPeriodNo(PeriodNo);
setName(name);
setStartDate(startDate);
setEndDate(endDate);
} // MPeriod
/**
* Copy constructor
* @param copy
*/
public MPeriod(MPeriod copy)
{
this(Env.getCtx(), copy);
}
/**
* Copy constructor
* @param ctx
* @param copy
*/
public MPeriod(Properties ctx, MPeriod copy)
{
this(ctx, copy, (String) null);
}
/**
* Copy constructor
* @param ctx
* @param copy
* @param trxName
*/
public MPeriod(Properties ctx, MPeriod copy, String trxName)
{
this(ctx, 0, trxName);
copyPO(copy);
this.m_C_Calendar_ID = copy.m_C_Calendar_ID;
this.m_controls = copy.m_controls != null ? Arrays.stream(copy.m_controls).map(e -> {return new MPeriodControl(ctx, e, trxName);}).toArray(MPeriodControl[]::new) : null;
}
/** Period Controls */
private MPeriodControl[] m_controls = null;
/**
* Get Period Control
* @param requery true to re-query from DB
* @return period controls
*/
public MPeriodControl[] getPeriodControls (boolean requery)
{
if (m_controls != null && !requery)
return m_controls;
//
ArrayList list = new ArrayList();
String sql = "SELECT * FROM C_PeriodControl "
+ "WHERE C_Period_ID=?";
PreparedStatement pstmt = null;
ResultSet rs = null;
try
{
pstmt = DB.prepareStatement(sql, null);
pstmt.setInt(1, getC_Period_ID());
rs = pstmt.executeQuery();
while (rs.next())
list.add (new MPeriodControl (getCtx(), rs, null));
}
catch (Exception e)
{
log.log(Level.SEVERE, sql, e);
}
finally
{
DB.close(rs, pstmt);
rs = null; pstmt = null;
}
//
if (list.size() > 0 && is_Immutable())
list.stream().forEach(e -> e.markImmutable());
m_controls = new MPeriodControl[list.size ()];
list.toArray (m_controls);
return m_controls;
} // getPeriodControls
/**
* Get Period Control
* @param DocBaseType Document Base Type (X_C_DocType.DOCBASETYPE_*)
* @return period control or null
*/
public MPeriodControl getPeriodControl (String DocBaseType)
{
if (DocBaseType == null)
return null;
getPeriodControls(false);
for (int i = 0; i < m_controls.length; i++)
{
if (DocBaseType.equals(m_controls[i].getDocBaseType()))
return m_controls[i];
}
return null;
} // getPeriodControl
/**
* Is Date In this Period
* @param date date
* @return true if date is in this period
*/
public boolean isInPeriod (Timestamp date)
{
if (date == null)
return false;
Timestamp dateOnly = TimeUtil.getDay(date);
Timestamp from = TimeUtil.getDay(getStartDate());
if (dateOnly.before(from))
return false;
Timestamp to = TimeUtil.getDay(getEndDate());
if (dateOnly.after(to))
return false;
return true;
} // isInPeriod
/**
* Is Period Open for Doc Base Type
* @param DocBaseType document base type
* @return true if open
* @deprecated since 3.3.1b; use {@link #isOpen(String, Timestamp)} instead
*/
@Deprecated
public boolean isOpen (String DocBaseType)
{
return isOpen(DocBaseType, null);
}
/**
* Is Period Open for Doc Base Type
* @param DocBaseType document base type (X_C_DocType.DOCBASETYPE_*)
* @param dateAcct date;
* Applies only for "Auto Period Control":
* if not null, date should be in auto period range (today - OpenHistory, today+OpenHistory)
* if null, this period should be in auto period range
* @return true if open
* @since 3.3.1b
*/
public boolean isOpen (String DocBaseType, Timestamp dateAcct)
{
return isOpen(DocBaseType, dateAcct, false);
}
/**
* Is Period Open for Doc Base Type
* @param DocBaseType document base type
* @param dateAcct date;
* Applies only for "Auto Period Control":
* if not null, date should be in auto period range (today - OpenHistory, today+OpenHistory)
* if null, this period should be in auto period range
* @param forPosting - true to check if the period is open for posting, false is for DocAction
* @return true if open
*/
public boolean isOpen (String DocBaseType, Timestamp dateAcct, boolean forPosting)
{
if (!isActive())
{
s_log.warning("Period not active: " + getName());
return false;
}
MAcctSchema as = MClient.get(getCtx(), getAD_Client_ID()).getAcctSchema();
if (as != null && as.isAutoPeriodControl())
{
Timestamp today = TimeUtil.trunc(new Timestamp (System.currentTimeMillis()), TimeUtil.TRUNC_DAY);
Timestamp first = TimeUtil.addDays(today, - as.getPeriod_OpenHistory());
Timestamp last = TimeUtil.addDays(today, as.getPeriod_OpenFuture());
Timestamp date1, date2;
if (dateAcct != null) {
date1 = TimeUtil.trunc(dateAcct, TimeUtil.TRUNC_DAY);
date2 = date1;
}
else {
date1 = getStartDate();
date2 = getEndDate();
}
//
if (date1.before(first))
{
log.warning ("Automatic Period Control:" + date1 + " before first day - " + first);
return false;
}
if (date2.after(last))
{
log.warning ("Automatic Period Control:" + date2 + " after last day - " + last);
return false;
}
// We are OK
if (isInPeriod(today) && as.getC_Period_ID() != getC_Period_ID())
{
as = new MAcctSchema(Env.getCtx(), as.getC_AcctSchema_ID(), null);
if (as.getC_Period_ID() != getC_Period_ID())
{
as.setC_Period_ID(getC_Period_ID());
as.saveEx();
}
}
return true;
}
// Standard Period Control
if (DocBaseType == null)
{
log.warning(getName() + " - No DocBaseType");
return false;
}
MPeriodControl pc = getPeriodControl (DocBaseType);
if (pc == null)
{
log.warning(getName() + " - Period Control not found for " + DocBaseType);
return false;
}
if (log.isLoggable(Level.FINE)) log.fine(getName() + ": " + DocBaseType);
return pc.isOpen(forPosting);
} // isOpen
/**
* Standard Period
* @return true if this is of standard calendar periods type (PERIODTYPE_StandardCalendarPeriod)
*/
public boolean isStandardPeriod()
{
return PERIODTYPE_StandardCalendarPeriod.equals(getPeriodType());
} // isStandardPeriod
@Override
protected boolean beforeSave (boolean newRecord)
{
// Truncate Dates
Timestamp date = getStartDate();
if (date != null)
setStartDate(TimeUtil.getDay(date));
else
return false;
date = getEndDate();
if (date != null)
setEndDate(TimeUtil.getDay(date));
else
setEndDate(TimeUtil.getMonthLastDay(getStartDate()));
// Validate EndDate > StartDate
if (getEndDate().before(getStartDate()))
{
SimpleDateFormat df = DisplayType.getDateFormat(DisplayType.Date);
log.saveError("Error", df.format(getEndDate()) + " < " + df.format(getStartDate()));
return false;
}
// Validate the StartDate and EndDate range does not overlap with another period record
MYear year = new MYear(getCtx(), getC_Year_ID(), get_TrxName());
Query query = MTable.get(getCtx(), "C_Period")
.createQuery("C_Year_ID IN (SELECT y.C_Year_ID from C_Year y WHERE" +
" y.C_Calendar_ID =?)" +
" AND (? BETWEEN StartDate AND EndDate" +
" OR ? BETWEEN StartDate AND EndDate)" +
" AND PeriodType=?",get_TrxName());
query.setParameters(year.getC_Calendar_ID(),
getStartDate(), getEndDate(),
getPeriodType());
List periods = query.list();
for ( int i=0; i < periods.size(); i++)
{
if ( periods.get(i).getC_Period_ID() != getC_Period_ID() )
{
log.saveError("Error", "Period overlaps with: " + periods.get(i).getName());
return false;
}
}
return true;
} // beforeSave
@Override
protected boolean afterSave (boolean newRecord, boolean success)
{
if (!success)
return success;
if (newRecord)
{
// Create new Period Control record for all DocBaseType
MDocType[] types = MDocType.getOfClient(getCtx());
int count = 0;
ArrayList baseTypes = new ArrayList();
for (int i = 0; i < types.length; i++)
{
MDocType type = types[i];
String DocBaseType = type.getDocBaseType();
if (baseTypes.contains(DocBaseType))
continue;
MPeriodControl pc = new MPeriodControl(this, DocBaseType);
pc.saveEx();
count++;
baseTypes.add (DocBaseType);
}
if (log.isLoggable(Level.FINE)) log.fine("PeriodControl #" + count);
}
return success;
} // afterSave
/**
* String Representation
* @return info
*/
@Override
public String toString ()
{
StringBuilder sb = new StringBuilder ("MPeriod[");
sb.append (get_ID())
.append("-").append (getName())
.append(", ").append(getStartDate()).append("-").append(getEndDate())
.append ("]");
return sb.toString ();
} // toString
/**
* Convenient method for testing if a period is open
* @param ctx
* @param dateAcct
* @param docBaseType
* @throws PeriodClosedException if period is closed
* @see #isOpen(Properties, Timestamp, String)
* @deprecated
*/
@Deprecated
public static void testPeriodOpen(Properties ctx, Timestamp dateAcct, String docBaseType)
throws PeriodClosedException
{
if (!MPeriod.isOpen(ctx, dateAcct, docBaseType, 0)) {
throw new PeriodClosedException(dateAcct, docBaseType);
}
}
/**
* Convenient method for testing if a period is open
* @param ctx
* @param dateAcct
* @param docBaseType X_C_DocType.DOCBASETYPE_*
* @param AD_Org_ID Organization
* @throws PeriodClosedException if period is closed
* @see #isOpen(Properties, Timestamp, String, int)
*/
public static void testPeriodOpen(Properties ctx, Timestamp dateAcct, String docBaseType, int AD_Org_ID)
throws PeriodClosedException
{
if (!MPeriod.isOpen(ctx, dateAcct, docBaseType, AD_Org_ID)) {
throw new PeriodClosedException(dateAcct, docBaseType);
}
}
/**
* Convenient method for testing if a period is open
* @param ctx
* @param dateAcct
* @param C_DocType_ID
* @throws PeriodClosedException
* @see {@link #isOpen(Properties, Timestamp, String)}
* @deprecated
*/
@Deprecated
public static void testPeriodOpen(Properties ctx, Timestamp dateAcct, int C_DocType_ID)
throws PeriodClosedException
{
MDocType dt = MDocType.get(ctx, C_DocType_ID);
testPeriodOpen(ctx, dateAcct, dt.getDocBaseType(), 0);
}
/**
* Convenient method for testing if a period is open
* @param ctx
* @param dateAcct
* @param C_DocType_ID
* @param AD_Org_ID Organization
* @throws PeriodClosedException
* @see {@link #isOpen(Properties, Timestamp, String, int)}
*/
public static void testPeriodOpen(Properties ctx, Timestamp dateAcct, int C_DocType_ID, int AD_Org_ID)
throws PeriodClosedException
{
MDocType dt = MDocType.get(ctx, C_DocType_ID);
testPeriodOpen(ctx, dateAcct, dt.getDocBaseType(), AD_Org_ID);
}
/**
* Get Calendar of Period
* @return C_Calendar_ID
*/
public int getC_Calendar_ID()
{
if (m_C_Calendar_ID == 0)
{
int calId = DB.getSQLValueEx(null, "SELECT C_Calendar_ID FROM C_Year WHERE C_Year_ID=?", getC_Year_ID());
if (calId >= 0)
m_C_Calendar_ID = calId;
else
log.severe("@NotFound@ C_Year_ID=" + getC_Year_ID());
}
return m_C_Calendar_ID;
} // getC_Calendar_ID
/**
* Get Calendar for Organization
* @param ctx Context
* @param AD_Org_ID Organization
* @return C_Calendar_ID
*/
public static int getC_Calendar_ID(Properties ctx,int AD_Org_ID)
{
int C_Calendar_ID = 0;
if (AD_Org_ID != 0)
{
MOrgInfo info = MOrgInfo.get(ctx, AD_Org_ID, null);
C_Calendar_ID = info.getC_Calendar_ID();
}
if (C_Calendar_ID == 0)
{
MClientInfo cInfo = MClientInfo.get(ctx);
C_Calendar_ID = cInfo.getC_Calendar_ID();
}
return C_Calendar_ID;
} // getC_Calendar_ID
@Override
public MPeriod markImmutable()
{
if (is_Immutable())
return this;
makeImmutable();
if (m_controls != null && m_controls.length > 0)
Arrays.stream(m_controls).forEach(e -> e.markImmutable());
return this;
}
/**
* Is the period has un-posted documents
* @return boolean - true if there is at least 1 un-posted document in this period
*/
public boolean hasUnpostedDocs() {
return hasUnpostedDocs(0);
}
/**
* Is this period has un-posted documents
* @param periodControlID C_PeriodControl_ID. If > 0, check only documents with the period control's DocBaseType
* @return boolean - true if there is at least 1 un-posted document in this period
*/
public boolean hasUnpostedDocs(int periodControlID) {
StringBuilder sql = new StringBuilder("SELECT 1 FROM RV_UnPosted up "
+ "WHERE up.DocStatus IN('CO', 'CL', 'RE', 'VO') AND up.AD_Client_ID=? AND up.DateAcct BETWEEN ? AND ? ");
sql.append(" AND AD_Org_ID IN (SELECT AD_Org_ID FROM AD_OrgInfo WHERE AD_Client_ID=? AND (C_Calendar_ID=?");
if (getC_Calendar_ID() == MClientInfo.get().getC_Calendar_ID()) {
sql.append(" OR C_Calendar_ID IS NULL");
}
sql.append(")) ");
if (periodControlID > 0)
sql.append(" AND up.DocBaseType = ? ");
sql.append(" FETCH FIRST 1 ROWS ONLY");
PreparedStatement pstmt = null;
ResultSet rs = null;
try
{
pstmt = DB.prepareStatement(sql.toString(), get_TrxName());
int idx = 1;
pstmt.setInt(idx++, Env.getAD_Client_ID(Env.getCtx()));
pstmt.setTimestamp(idx++, getStartDate());
pstmt.setTimestamp(idx++, getEndDate());
pstmt.setInt(idx++, Env.getAD_Client_ID(Env.getCtx()));
pstmt.setInt(idx++, getC_Calendar_ID());
if (periodControlID > 0) {
MPeriodControl pc = new MPeriodControl(getCtx(), periodControlID, get_TrxName());
pstmt.setString(idx++, pc.getDocBaseType());
}
rs = pstmt.executeQuery();
if(rs.next()) {
return true;
}
}
catch (SQLException e)
{
throw new DBException(e, sql.toString());
}
finally
{
DB.close(rs, pstmt);
rs = null; pstmt = null;
}
return false;
}
} // MPeriod