/**
* Is standard Period closed for all Document Base Types
*
* @param ctx context for AD_Client
* @param DateAcct accounting date
* @return true if closed
*/
public static boolean isClosed(Ctx ctx, Timestamp DateAcct) {
if (DateAcct == null) return false;
MAcctSchema as = MClient.get(ctx, ctx.getAD_Client_ID()).getAcctSchema();
if (as.isAutoPeriodControl()) return !as.isAutoPeriodControlOpen(DateAcct);
// Get all Calendars in line with Organizations
MClientInfo cInfo = MClientInfo.get(ctx, ctx.getAD_Client_ID(), null);
ArrayList<Integer> calendars = new ArrayList<Integer>();
MOrg[] orgs = MOrg.getOfClient(cInfo);
for (MOrg org : orgs) {
MOrgInfo info = MOrgInfo.get(ctx, org.getAD_Org_ID(), null);
int C_Calendar_ID = info.getC_Calendar_ID();
if (C_Calendar_ID == 0) C_Calendar_ID = cInfo.getC_Calendar_ID();
if (!calendars.contains(C_Calendar_ID)) calendars.add(C_Calendar_ID);
}
// Should not happen
if (calendars.size() == 0) throw new IllegalArgumentException("@NotFound@ @C_Calendar_ID@");
// For all Calendars get Periods
for (int i = 0; i < calendars.size(); i++) {
int C_Calendar_ID = calendars.get(i);
MPeriod period = MPeriod.getOfCalendar(ctx, C_Calendar_ID, DateAcct);
// Period not found
if (period == null) return false;
if (!period.isClosed()) return false;
}
return true; // closed
} // isClosed
/**
* Returns the previous period
*
* @param period MPeriod
* @param periodCount Count
* @param trx trx
* @param ctx Ctx
* @return MPeriod
*/
public static MPeriod getPreviousPeriod(MPeriod period, Ctx ctx, Trx trx) {
MPeriod newPeriod = null;
String sql =
"SELECT * FROM C_Period WHERE "
+ "C_Period.IsActive='Y' AND PeriodType='S' "
+ "AND C_Period.C_Year_ID IN "
+ "(SELECT C_Year_ID FROM C_Year WHERE C_Year.C_Calendar_ID = ? ) "
+ "AND ((C_Period.C_Year_ID * 1000) + C_Period.PeriodNo) "
+ " < ((? * 1000) + ?) ORDER BY C_Period.C_Year_ID DESC, C_Period.PeriodNo DESC";
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
pstmt = DB.prepareStatement(sql, trx);
pstmt.setInt(1, period.getC_Calendar_ID());
pstmt.setInt(2, period.getC_Year_ID());
pstmt.setInt(3, period.getPeriodNo());
rs = pstmt.executeQuery();
if (rs.next()) newPeriod = new MPeriod(ctx, rs, trx);
} catch (Exception e) {
s_log.log(Level.SEVERE, sql, e);
} finally {
DB.closeResultSet(rs);
DB.closeStatement(pstmt);
}
return newPeriod;
}
/**
* Get Period from Cache
*
* @param ctx context
* @param C_Period_ID id
* @return MPeriod
*/
public static MPeriod get(Ctx ctx, int C_Period_ID) {
Integer key = Integer.valueOf(C_Period_ID);
MPeriod retValue = s_cache.get(ctx, key);
if (retValue != null) return retValue;
//
retValue = new MPeriod(ctx, C_Period_ID, null);
if (retValue.get_ID() != 0) s_cache.put(key, retValue);
return retValue;
} // get
/**
* Is standard Period Open for Document Base Type - does not check Orgs
*
* @param ctx context
* @param DateAcct date
* @param DocBaseType base type
* @return true if open
* @deprecated use new isOpen
*/
@Deprecated
public static boolean isOpenOld(Ctx ctx, Timestamp DateAcct, String DocBaseType) {
if (DateAcct == null) {
s_log.warning("No DateAcct");
return false;
}
if (DocBaseType == null) {
s_log.warning("No DocBaseType");
return false;
}
MPeriod period = MPeriod.getOfOrg(ctx, 0, DateAcct);
if (period == null) {
s_log.warning("No Period for " + DateAcct + " (" + DocBaseType + ")");
return false;
}
String error = period.isOpen(DocBaseType, DateAcct);
if (error != null) s_log.warning(error + " - " + period.getName());
return error == null;
} // isOpen
/**
* Find standard Period of DateAcct based on Client Calendar
*
* @param ctx context
* @param C_Calendar_ID calendar
* @param DateAcct date
* @return active Period or null
*/
public static MPeriod getOfCalendar(Ctx ctx, int C_Calendar_ID, Timestamp DateAcct) {
if (DateAcct == null) {
s_log.warning("No DateAcct");
return null;
}
if (C_Calendar_ID == 0) {
s_log.warning("No Calendar");
return null;
}
// Search in Cache first
Iterator<MPeriod> it = s_cache.values().iterator();
while (it.hasNext()) {
MPeriod period = it.next();
if (period.getC_Calendar_ID() == C_Calendar_ID
&& period.isStandardPeriod()
&& period.isInPeriod(DateAcct)) 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,'DD') AND TRUNC(EndDate,'DD')"
+ " AND IsActive='Y' AND PeriodType='S'";
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
pstmt = DB.prepareStatement(sql, (Trx) null);
pstmt.setInt(1, C_Calendar_ID);
pstmt.setTimestamp(2, TimeUtil.getDay(DateAcct));
rs = pstmt.executeQuery();
while (rs.next()) {
MPeriod period = new MPeriod(ctx, rs, null);
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.closeStatement(pstmt);
DB.closeResultSet(rs);
}
if (retValue == null)
s_log.warning(
"No Standard Period for " + DateAcct + " (C_Calendar_ID=" + C_Calendar_ID + ")");
return retValue;
} // get
/**
* gets all Periods in the Range
*
* @param startPeriod
* @param endPeriod
* @param calendar_ID
* @return MPeriod[]
*/
public static MPeriod[] getAllPeriodsInRange(
MPeriod startPeriod, MPeriod endPeriod, int calendar_ID, Ctx ctx, Trx trx) {
if ((startPeriod.getC_Calendar_ID() != calendar_ID)
|| (endPeriod.getC_Calendar_ID() != calendar_ID)) {
log.saveError("Error", "Periods do not belong to the calendar");
return null;
}
ArrayList<MPeriod> periods = new ArrayList<MPeriod>();
String sql =
"SELECT * FROM C_Period WHERE "
+ "C_Period.IsActive='Y' AND PeriodType='S' "
+ "AND C_Period.C_Year_ID IN "
+ "(SELECT C_Year_ID FROM C_Year WHERE C_Year.C_Calendar_ID = ? ) "
+ // calendar_ID
"AND ((C_Period.C_Year_ID * 1000) + C_Period.PeriodNo) BETWEEN"
+ " (? * 1000 + ?) AND (? * 1000 + ? )"
+ // start Period year ID, Period Number , End Period Year ID, Period Number
" ORDER BY C_Period.C_Year_ID ASC, C_Period.PeriodNo ASC";
PreparedStatement pstmt = null;
ResultSet rs = null;
try {
pstmt = DB.prepareStatement(sql, trx);
pstmt.setInt(1, calendar_ID);
pstmt.setInt(2, startPeriod.getC_Year_ID());
pstmt.setInt(3, startPeriod.getPeriodNo());
pstmt.setInt(4, endPeriod.getC_Year_ID());
pstmt.setInt(5, endPeriod.getPeriodNo());
rs = pstmt.executeQuery();
while (rs.next()) periods.add(new MPeriod(ctx, rs, trx));
} catch (Exception e) {
s_log.log(Level.SEVERE, sql, e);
} finally {
DB.closeResultSet(rs);
DB.closeStatement(pstmt);
}
MPeriod[] retValue = new MPeriod[periods.size()];
periods.toArray(retValue);
return retValue;
}
/**
* Before Save. Truncate Dates
*
* @param newRecord new
* @return true
*/
@Override
protected boolean beforeSave(boolean newRecord) {
Timestamp startdate = getStartDate();
Timestamp enddate = getEndDate();
if (enddate != null && startdate.after(enddate)) {
s_log.saveError("Error", Msg.getMsg(getCtx(), "CalPeriodInvalidDate"));
return false;
}
// Truncate Dates
startdate = TimeUtil.getDay(startdate);
setStartDate(startdate);
if (enddate != null) enddate = TimeUtil.getDay(enddate);
else enddate = TimeUtil.getMonthLastDay(getStartDate());
// Adding the time component of 23:59:59 to the end date
enddate = new Timestamp(enddate.getTime() + 86399000);
setEndDate(enddate);
MPeriod[] periods = getAllPeriodsInYear(getC_Year_ID(), "S", getCtx(), get_Trx());
MPeriod[] allperiods = getAllPeriodsInCalendar(getC_Calendar_ID(), "S", getCtx(), get_Trx());
// Check for non-negative period number
if (getPeriodNo() < 0) {
s_log.saveError("Error", Msg.getMsg(getCtx(), "CalNegPeriodNo"));
return false;
}
// Check for standard period
if (isStandardPeriod() == true) {
// Check Period number is in ascending order
Timestamp nextPeriodStartDate = null;
Timestamp prevPeriodStartDate = null;
// Get the next standard period number Start Date in this year
String sql =
"SELECT StartDate FROM C_Period WHERE "
+ "C_Period.IsActive='Y' AND PeriodType='S' "
+ "AND C_Period.C_Year_ID =? "
+ "AND C_Period.C_Period_ID <> ?"
+ "AND C_Period.PeriodNo "
+ " > ? ORDER BY C_Period.PeriodNo ASC";
Object[][] result = null;
result =
QueryUtil.executeQuery(get_Trx(), sql, getC_Year_ID(), getC_Period_ID(), getPeriodNo());
if (result.length != 0) nextPeriodStartDate = (Timestamp) result[0][0];
// Get the previous standard period number Start Date in this year
sql =
"SELECT StartDate FROM C_Period WHERE "
+ "C_Period.IsActive='Y' AND PeriodType='S' "
+ "AND C_Period.C_Year_ID =? "
+ "AND C_Period.C_Period_ID <> ?"
+ "AND C_Period.PeriodNo "
+ "< ? ORDER BY C_Period.PeriodNo DESC";
result =
QueryUtil.executeQuery(get_Trx(), sql, getC_Year_ID(), getC_Period_ID(), getPeriodNo());
if (result.length != 0) prevPeriodStartDate = (Timestamp) result[0][0];
if ((prevPeriodStartDate != null
&& TimeUtil.max(prevPeriodStartDate, startdate) == prevPeriodStartDate)) {
s_log.saveError("Error", Msg.getMsg(getCtx(), "CalPeriodAsc"));
return false;
}
if ((nextPeriodStartDate != null
&& TimeUtil.max(nextPeriodStartDate, startdate) == startdate)) {
s_log.saveError("Error", Msg.getMsg(getCtx(), "CalPeriodAsc"));
return false;
}
// Check if the Standard Period is overlapping other periods.
for (MPeriod period : allperiods) {
if ((TimeUtil.isValid(period.getStartDate(), period.getEndDate(), startdate) == true
|| TimeUtil.isValid(period.getStartDate(), period.getEndDate(), enddate) == true)
&& period.getC_Period_ID() != getC_Period_ID()) {
s_log.saveError("Error", Msg.getMsg(getCtx(), "CalPeriodOverlap"));
return false;
}
}
}
// Check for adjusting period
else {
boolean startflag = false;
boolean endflag = false;
for (MPeriod period : periods) {
if (TimeUtil.isValid(period.getStartDate(), period.getEndDate(), startdate) == true)
startflag = true;
if (TimeUtil.isValid(period.getStartDate(), period.getEndDate(), enddate) == true)
endflag = true;
if (startflag == true && endflag == true) break;
}
if (startflag == false || endflag == false) {
s_log.saveError("Error", Msg.getMsg(getCtx(), "CalAdjPeriod"));
return false;
}
}
return true;
} // beforeSave
/**
* Is standard Period Open for specified orgs for the client. For best performance, ensure that
* the list of orgs does not contain duplicates.
*
* @param ctx
* @param AD_Client_ID
* @param orgs
* @param DateAcct accounting date
* @param DocBaseType document base type
* @return error message or null
*/
public static String isOpen(
Ctx ctx, int AD_Client_ID, ArrayList<Integer> orgs, Timestamp DateAcct, String DocBaseType) {
if (DateAcct == null) return "@NotFound@ @DateAcct@";
if (DocBaseType == null) return "@NotFound@ @DocBaseType@";
MAcctSchema as = MClient.get(ctx, AD_Client_ID).getAcctSchema();
if (as == null) return "@NotFound@ @C_AcctSchema_ID@ for AD_Client_ID=" + AD_Client_ID;
if (as.isAutoPeriodControl()) {
if (as.isAutoPeriodControlOpen(DateAcct)) return null;
else return "@PeriodClosed@ - @AutoPeriodControl@";
}
// Get all Calendars in line with Organizations
MClientInfo clientInfo = MClientInfo.get(ctx, AD_Client_ID, null);
ArrayList<Integer> orgCalendars = new ArrayList<Integer>();
ArrayList<Integer> calendars = new ArrayList<Integer>();
for (int org : orgs) {
MOrgInfo orgInfo = MOrgInfo.get(ctx, org, null);
int C_Calendar_ID = orgInfo.getC_Calendar_ID();
if (C_Calendar_ID == 0) C_Calendar_ID = clientInfo.getC_Calendar_ID();
orgCalendars.add(C_Calendar_ID);
if (!calendars.contains(C_Calendar_ID)) calendars.add(C_Calendar_ID);
}
// Should not happen
if (calendars.size() == 0) return "@NotFound@ @C_Calendar_ID@";
// For all Calendars get Periods
for (int i = 0; i < calendars.size(); i++) {
int C_Calendar_ID = calendars.get(i);
MPeriod period = MPeriod.getOfCalendar(ctx, C_Calendar_ID, DateAcct);
// First Org for Calendar
int AD_Org_ID = 0;
for (int j = 0; j < orgCalendars.size(); j++) {
if (orgCalendars.get(j) == C_Calendar_ID) {
AD_Org_ID = orgs.get(j);
break;
}
}
if (period == null) {
MCalendar cal = MCalendar.get(ctx, C_Calendar_ID);
String date = DisplayType.getDateFormat(DisplayTypeConstants.Date).format(DateAcct);
if (cal != null)
return "@NotFound@ @C_Period_ID@: "
+ date
+ " - "
+ MOrg.get(ctx, AD_Org_ID).getName()
+ " -> "
+ cal.getName();
else
return "@NotFound@ @C_Period_ID@: "
+ date
+ " - "
+ MOrg.get(ctx, AD_Org_ID).getName()
+ " -> C_Calendar_ID="
+ C_Calendar_ID;
}
String error = period.isOpen(DocBaseType, DateAcct);
if (error != null)
return error
+ " - "
+ MOrg.get(ctx, AD_Org_ID).getName()
+ " -> "
+ MCalendar.get(ctx, C_Calendar_ID).getName();
}
return null; // open
} // isOpen
/**
* Find valid standard Period of DateAcct based on Client Calendar
*
* @param ctx context
* @param DateAcct date
* @return C_Period_ID or 0
*/
public static int getC_Period_ID(Ctx ctx, int AD_Org_ID, Timestamp DateAcct) {
MPeriod period = getOfOrg(ctx, AD_Org_ID, DateAcct);
if (period == null) return 0;
return period.getC_Period_ID();
} // getC_Period_ID