org.spin.tar.model.MHRIncidence Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of time-and-attendance Show documentation
Show all versions of time-and-attendance Show documentation
Time and Attendance Management dedicated to manage Attendance, and members.
/*************************************************************************************
* Product: Adempiere ERP & CRM Smart Business Solution *
* This program is free software; you can redistribute it and/or modify it *
* under the terms version 2 or later 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 *
* Copyright (C) 2012-2018 E.R.P. Consultores y Asociados, S.A. All Rights Reserved. *
* Contributor(s): Yamel Senih www.erpya.com *
*************************************************************************************/
package org.spin.tar.model;
import java.io.File;
import java.math.BigDecimal;
import java.sql.ResultSet;
import java.sql.Timestamp;
import java.util.Properties;
import org.adempiere.core.domains.models.X_HR_Incidence;
import org.adempiere.core.domains.models.X_HR_ShiftIncidence;
import org.adempiere.exceptions.AdempiereException;
import org.compiere.model.MDocType;
import org.compiere.model.MPeriod;
import org.compiere.model.ModelValidationEngine;
import org.compiere.model.ModelValidator;
import org.compiere.process.DocAction;
import org.compiere.process.DocOptions;
import org.compiere.process.DocumentEngine;
import org.compiere.util.DB;
import org.compiere.util.Env;
import org.compiere.util.Msg;
import org.compiere.util.Util;
/** Generated Model for HR_Incidence
* @author Adempiere (generated)
* @version Release 3.9.0 - $Id$ */
public class MHRIncidence extends X_HR_Incidence implements DocAction, DocOptions {
/**
*
*/
private static final long serialVersionUID = 20180728L;
/** Standard documents */
public static final String DocBaseType_Standard = "TNI";
/** Standard Constructor */
public MHRIncidence (Properties ctx, int HR_Incidence_ID, String trxName)
{
super (ctx, HR_Incidence_ID, trxName);
}
/** Load Constructor */
public MHRIncidence (Properties ctx, ResultSet rs, String trxName)
{
super (ctx, rs, trxName);
}
/**
* Create from Attendance batch and Shift Incidence
* @param batch
* @param shiftIncidence
* @param durationInMillis
*/
public MHRIncidence(MHRAttendanceBatch batch, MHRShiftIncidence shiftIncidence, long durationInMillis) {
super(batch.getCtx(), 0, batch.get_TrxName());
// Set default values
setHR_AttendanceBatch_ID(batch.getHR_AttendanceBatch_ID());
setDateDoc(batch.getDateDoc());
setServiceDate(batch.getDateDoc());
setC_BPartner_ID(batch.getC_BPartner_ID());
setHR_Employee_ID(batch.getHR_Employee_ID());
setHR_ShiftIncidence_ID(shiftIncidence.getHR_ShiftIncidence_ID());
setHR_Concept_ID(shiftIncidence.getHR_Concept_ID());
// Validate time
if(durationInMillis == 0
|| Util.isEmpty(shiftIncidence.getTimeUnit())) {
if(shiftIncidence.getFixedQty() != null
&& !shiftIncidence.getFixedQty().equals(Env.ZERO)) {
setQty(shiftIncidence.getFixedQty());
}if(shiftIncidence.getFixedAmt() != null
&& !shiftIncidence.getFixedAmt().equals(Env.ZERO)) {
setAmt(shiftIncidence.getFixedAmt());
}
} else {
// Set Quantity
double time = getTime(shiftIncidence.getTimeUnit(), durationInMillis);
if(time == 0) {
throw new AdempiereException("@TimeUnit@ @NotFound@");
}
//
setQty(new BigDecimal(time));
}
}
/**
* Create from Attendance batch and Shift Incidence from leave hours
* @param batch
* @param shiftIncidence
* @param durationInHours
*/
public MHRIncidence(MHRAttendanceBatch batch, MHRShiftIncidence shiftIncidence, BigDecimal durationInHours) {
super(batch.getCtx(), 0, batch.get_TrxName());
// Set default values
setHR_AttendanceBatch_ID(batch.getHR_AttendanceBatch_ID());
setDateDoc(batch.getDateDoc());
setServiceDate(batch.getDateDoc());
setC_BPartner_ID(batch.getC_BPartner_ID());
setHR_Employee_ID(batch.getHR_Employee_ID());
setHR_ShiftIncidence_ID(shiftIncidence.getHR_ShiftIncidence_ID());
setHR_Concept_ID(shiftIncidence.getHR_Concept_ID());
// Validate time
if(durationInHours == null
|| durationInHours.doubleValue() == 0
|| Util.isEmpty(shiftIncidence.getTimeUnit())) {
if(shiftIncidence.getFixedQty() != null
&& !shiftIncidence.getFixedQty().equals(Env.ZERO)) {
setQty(shiftIncidence.getFixedQty());
}if(shiftIncidence.getFixedAmt() != null
&& !shiftIncidence.getFixedAmt().equals(Env.ZERO)) {
setAmt(shiftIncidence.getFixedAmt());
}
} else {
// Set Quantity
if(durationInHours == null
|| durationInHours.doubleValue() == 0) {
throw new AdempiereException("@TimeUnit@ @NotFound@");
}
//
setQty(durationInHours);
}
}
/**
* Get Time from duration and time unit
* @param timeUnit
* @param durationInMillis
* @return
*/
public static double getTime(String timeUnit, long durationInMillis) {
if(Util.isEmpty(timeUnit)) {
return 0;
}
// Set time
double time = 0;
if(timeUnit.equals(X_HR_ShiftIncidence.TIMEUNIT_Minute)) {
time = (durationInMillis / (double)(1000 * 60));
} else if(timeUnit.equals(X_HR_ShiftIncidence.TIMEUNIT_Hour)) {
time = (durationInMillis / (double)(1000 * 60 * 60));
} else if(timeUnit.equals(X_HR_ShiftIncidence.TIMEUNIT_Day)) {
time = (durationInMillis / (double)(1000 * 60 * 60 * 24));
}
// Return
return time;
}
/**
* Get Document Info
* @return document info (untranslated)
*/
public String getDocumentInfo()
{
MDocType dt = MDocType.get(getCtx(), getC_DocType_ID());
return dt.getName() + " " + getDocumentNo();
} // getDocumentInfo
/**
* Create PDF
* @return File or null
*/
public File createPDF ()
{
try
{
File temp = File.createTempFile(get_TableName() + get_ID() +"_", ".pdf");
return createPDF (temp);
}
catch (Exception e)
{
log.severe("Could not create PDF - " + e.getMessage());
}
return null;
} // getPDF
/**
* Create PDF file
* @param file output file
* @return file if success
*/
public File createPDF (File file)
{
// ReportEngine re = ReportEngine.get (getCtx(), ReportEngine.INVOICE, getC_Invoice_ID());
// if (re == null)
return null;
// return re.getPDF(file);
} // createPDF
/**************************************************************************
* Process document
* @param processAction document action
* @return true if performed
*/
public boolean processIt (String processAction)
{
m_processMsg = null;
DocumentEngine engine = new DocumentEngine (this, getDocStatus());
return engine.processIt (processAction, getDocAction());
} // processIt
/** Process Message */
private String m_processMsg = null;
/** Just Prepared Flag */
private boolean m_justPrepared = false;
/**
* Set Document Type
*/
public void setC_DocType_ID() {
String sql = "SELECT C_DocType_ID FROM C_DocType "
+ "WHERE AD_Client_ID = ? AND AD_Org_ID IN (0," + getAD_Org_ID()
+ ") AND DocBaseType = ? "
+ " AND IsActive = 'Y' "
+ "ORDER BY AD_Org_ID, IsDefault DESC";
int C_DocType_ID = DB.getSQLValue(null, sql, getAD_Client_ID(), DocBaseType_Standard);
if (C_DocType_ID <= 0) {
log.severe ("Not found for AD_Client_ID=" + getAD_Client_ID () + ", DocBaseType=" + DocBaseType_Standard);
} else {
log.fine("(APS) - " + DocBaseType_Standard);
setC_DocType_ID(C_DocType_ID);
}
} // setC_DocTypeTarget_ID
@Override
protected boolean beforeSave(boolean newRecord) {
if(newRecord) {
// Set Document Type
if(getC_DocType_ID() == 0) {
setC_DocType_ID();
}
}
return super.beforeSave(newRecord);
}
/**
* Unlock Document.
* @return true if success
*/
public boolean unlockIt()
{
log.info("unlockIt - " + toString());
// setProcessing(false);
return true;
} // unlockIt
/**
* Invalidate Document
* @return true if success
*/
public boolean invalidateIt()
{
log.info("invalidateIt - " + toString());
setDocAction(DOCACTION_Prepare);
return true;
} // invalidateIt
/**
* Prepare Document
* @return new status (In Progress or Invalid)
*/
public String prepareIt()
{
log.info(toString());
m_processMsg = ModelValidationEngine.get().fireDocValidate(this, ModelValidator.TIMING_BEFORE_PREPARE);
if (m_processMsg != null)
return DocAction.STATUS_Invalid;
MDocType dt = MDocType.get(getCtx(), getC_DocType_ID());
// Std Period open?
if (!MPeriod.isOpen(getCtx(), getDateDoc(), dt.getDocBaseType(), getAD_Org_ID()))
{
m_processMsg = "@PeriodClosed@";
return DocAction.STATUS_Invalid;
}
// Add up Amounts
m_processMsg = ModelValidationEngine.get().fireDocValidate(this, ModelValidator.TIMING_AFTER_PREPARE);
if (m_processMsg != null)
return DocAction.STATUS_Invalid;
m_justPrepared = true;
if (!DOCACTION_Complete.equals(getDocAction()))
setDocAction(DOCACTION_Complete);
return DocAction.STATUS_InProgress;
} // prepareIt
/**
* Approve Document
* @return true if success
*/
public boolean approveIt()
{
log.info("approveIt - " + toString());
setIsApproved(true);
return true;
} // approveIt
/**
* Reject Approval
* @return true if success
*/
public boolean rejectIt()
{
log.info("rejectIt - " + toString());
setIsApproved(false);
return true;
} // rejectIt
/**
* Complete Document
* @return new status (Complete, In Progress, Invalid, Waiting ..)
*/
public String completeIt()
{
// Re-Check
if (!m_justPrepared)
{
String status = prepareIt();
if (!DocAction.STATUS_InProgress.equals(status))
return status;
}
m_processMsg = ModelValidationEngine.get().fireDocValidate(this, ModelValidator.TIMING_BEFORE_COMPLETE);
if (m_processMsg != null)
return DocAction.STATUS_Invalid;
// Implicit Approval
if (!isApproved())
approveIt();
log.info(toString());
//
// User Validation
String valid = ModelValidationEngine.get().fireDocValidate(this, ModelValidator.TIMING_AFTER_COMPLETE);
if (valid != null)
{
m_processMsg = valid;
return DocAction.STATUS_Invalid;
}
// Set Definitive Document No
setDefiniteDocumentNo();
setProcessed(true);
setDocAction(DOCACTION_Close);
return DocAction.STATUS_Completed;
} // completeIt
/**
* Set the definite document number after completed
*/
private void setDefiniteDocumentNo() {
MDocType dt = MDocType.get(getCtx(), getC_DocType_ID());
if (dt.isOverwriteDateOnComplete()) {
setDateDoc(new Timestamp(System.currentTimeMillis()));
}
if (dt.isOverwriteSeqOnComplete()) {
String value = null;
int index = p_info.getColumnIndex("C_DocType_ID");
if (index == -1)
index = p_info.getColumnIndex("C_DocTypeTarget_ID");
if (index != -1) // get based on Doc Type (might return null)
value = DB.getDocumentNo(get_ValueAsInt(index), get_TrxName(), true);
if (value != null) {
setDocumentNo(value);
}
}
}
/**
* Void Document.
* Same as Close.
* @return true if success
*/
public boolean voidIt()
{
log.info("voidIt - " + toString());
// Before Void
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_BEFORE_VOID);
if (m_processMsg != null)
return false;
addDescription(Msg.getMsg(getCtx(), "Voided"));
// After Void
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_AFTER_VOID);
if (m_processMsg != null)
return false;
setProcessed(true);
setDocAction(DOCACTION_None);
return true;
} // voidIt
/**
* Add to Description
* @param description text
*/
public void addDescription (String description) {
String desc = getDescription();
if (desc == null)
setDescription(description);
else
setDescription(desc + " | " + description);
} // addDescription
/**
* Close Document.
* Cancel not delivered Qunatities
* @return true if success
*/
public boolean closeIt() {
log.info("closeIt - " + toString());
// Before Close
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_BEFORE_CLOSE);
if (m_processMsg != null)
return false;
setProcessed(true);
setDocAction(DOCACTION_None);
// After Close
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_AFTER_CLOSE);
if (m_processMsg != null)
return false;
return true;
} // closeIt
/**
* Reverse Correction
* @return true if success
*/
public boolean reverseCorrectIt()
{
log.info("reverseCorrectIt - " + toString());
// Before reverseCorrect
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_BEFORE_REVERSECORRECT);
if (m_processMsg != null)
return false;
// Void It
voidIt();
// After reverseCorrect
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_AFTER_REVERSECORRECT);
if (m_processMsg != null)
return false;
return false;
} // reverseCorrectionIt
/**
* Reverse Accrual - none
* @return true if success
*/
public boolean reverseAccrualIt()
{
log.info("reverseAccrualIt - " + toString());
// Before reverseAccrual
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_BEFORE_REVERSEACCRUAL);
if (m_processMsg != null)
return false;
// Void It
voidIt();
// After reverseAccrual
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_AFTER_REVERSEACCRUAL);
if (m_processMsg != null)
return false;
return false;
} // reverseAccrualIt
/**
* Re-activate
* @return true if success
*/
public boolean reActivateIt()
{
log.info("reActivateIt - " + toString());
// Before reActivate
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_BEFORE_REACTIVATE);
if (m_processMsg != null)
return false;
// After reActivate
m_processMsg = ModelValidationEngine.get().fireDocValidate(this,ModelValidator.TIMING_AFTER_REACTIVATE);
if (m_processMsg != null)
return false;
setDocAction(DOCACTION_Complete);
setProcessed(false);
return true;
} // reActivateIt
/*************************************************************************
* Get Summary
* @return Summary of Document
*/
public String getSummary()
{
StringBuffer sb = new StringBuffer();
sb.append(getDocumentNo());
// sb.append(": ")
// .append(Msg.translate(getCtx(),"TotalLines")).append("=").append(getTotalLines())
// .append(" (#").append(getLines(false).length).append(")");
// - Description
if (getDescription() != null && getDescription().length() > 0)
sb.append(" - ").append(getDescription());
return sb.toString();
} // getSummary
/**
* Get Process Message
* @return clear text error message
*/
public String getProcessMsg()
{
return m_processMsg;
} // getProcessMsg
/**
* Get Document Owner (Responsible)
* @return AD_User_ID
*/
public int getDoc_User_ID()
{
// return getSalesRep_ID();
return 0;
} // getDoc_User_ID
/**
* Get Document Approval Amount
* @return amount
*/
public BigDecimal getApprovalAmt()
{
return null; //getTotalLines();
} // getApprovalAmt
/**
* Get Document Currency
* @return C_Currency_ID
*/
public int getC_Currency_ID()
{
// MPriceList pl = MPriceList.get(getCtx(), getM_PriceList_ID());
// return pl.getC_Currency_ID();
return 0;
} // getC_Currency_ID
@Override
public int customizeValidActions(String docStatus, Object processing,
String orderType, String isSOTrx, int AD_Table_ID,
String[] docAction, String[] options, int index) {
// Valid Document Action
if (AD_Table_ID == Table_ID){
if (docStatus.equals(DocumentEngine.STATUS_Drafted)
|| docStatus.equals(DocumentEngine.STATUS_InProgress)
|| docStatus.equals(DocumentEngine.STATUS_Invalid)) {
options[index++] = DocumentEngine.ACTION_Prepare;
}
// Complete .. CO
else if (docStatus.equals(DocumentEngine.STATUS_Completed)) {
options[index++] = DocumentEngine.ACTION_ReActivate;
options[index++] = DocumentEngine.ACTION_Void;
}
}
// Default
return index;
}
@Override
public String toString()
{
StringBuffer sb = new StringBuffer ("MHRIncidence[")
.append(getSummary()).append("]");
return sb.toString();
}
}