/*
* The Kuali Financial System, a comprehensive financial management system for higher education.
*
* Copyright 2005-2014 The Kuali Foundation
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.kuali.kfs.module.tem.document;
import java.beans.PropertyChangeEvent;
import java.sql.Date;
import java.sql.Timestamp;
import java.text.MessageFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Transient;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import org.kuali.kfs.coa.service.OffsetDefinitionService;
import org.kuali.kfs.fp.document.DisbursementVoucherDocument;
import org.kuali.kfs.module.tem.TemConstants;
import org.kuali.kfs.module.tem.TemConstants.TravelAuthorizationParameters;
import org.kuali.kfs.module.tem.TemConstants.TravelAuthorizationStatusCodeKeys;
import org.kuali.kfs.module.tem.TemConstants.TravelDocTypes;
import org.kuali.kfs.module.tem.TemConstants.TravelParameters;
import org.kuali.kfs.module.tem.TemKeyConstants;
import org.kuali.kfs.module.tem.TemParameterConstants;
import org.kuali.kfs.module.tem.TemPropertyConstants;
import org.kuali.kfs.module.tem.TemWorkflowConstants;
import org.kuali.kfs.module.tem.businessobject.ActualExpense;
import org.kuali.kfs.module.tem.businessobject.HeldEncumbranceEntry;
import org.kuali.kfs.module.tem.businessobject.ImportedExpense;
import org.kuali.kfs.module.tem.businessobject.PerDiemExpense;
import org.kuali.kfs.module.tem.businessobject.TemExpense;
import org.kuali.kfs.module.tem.businessobject.TemProfile;
import org.kuali.kfs.module.tem.businessobject.TemSourceAccountingLine;
import org.kuali.kfs.module.tem.businessobject.TransportationModeDetail;
import org.kuali.kfs.module.tem.businessobject.TravelAdvance;
import org.kuali.kfs.module.tem.businessobject.TravelPayment;
import org.kuali.kfs.module.tem.businessobject.TravelerDetailEmergencyContact;
import org.kuali.kfs.module.tem.document.service.TravelAuthorizationService;
import org.kuali.kfs.module.tem.service.TemExpenseService;
import org.kuali.kfs.sys.KFSConstants;
import org.kuali.kfs.sys.KFSPropertyConstants;
import org.kuali.kfs.sys.batch.service.PaymentSourceExtractionService;
import org.kuali.kfs.sys.businessobject.AccountingLine;
import org.kuali.kfs.sys.businessobject.FinancialSystemDocumentHeader;
import org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry;
import org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper;
import org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail;
import org.kuali.kfs.sys.businessobject.PaymentSourceWireTransfer;
import org.kuali.kfs.sys.businessobject.WireCharge;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.kfs.sys.document.AmountTotaling;
import org.kuali.kfs.sys.document.PaymentSource;
import org.kuali.kfs.sys.document.service.PaymentSourceHelperService;
import org.kuali.kfs.sys.document.validation.event.AddAccountingLineEvent;
import org.kuali.kfs.sys.document.validation.event.DeleteAccountingLineEvent;
import org.kuali.kfs.sys.document.validation.event.ReviewAccountingLineEvent;
import org.kuali.kfs.sys.service.AccountingLineService;
import org.kuali.kfs.sys.service.OptionsService;
import org.kuali.kfs.sys.service.UniversityDateService;
import org.kuali.rice.core.api.config.property.ConfigurationService;
import org.kuali.rice.core.api.util.type.KualiDecimal;
import org.kuali.rice.kew.api.KewApiServiceLocator;
import org.kuali.rice.kew.api.document.DocumentStatus;
import org.kuali.rice.kew.api.document.attribute.DocumentAttributeIndexingQueue;
import org.kuali.rice.kew.api.exception.WorkflowException;
import org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange;
import org.kuali.rice.kim.api.identity.Person;
import org.kuali.rice.kim.api.identity.PersonService;
import org.kuali.rice.krad.bo.PersistableBusinessObject;
import org.kuali.rice.krad.document.Document;
import org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent;
import org.kuali.rice.krad.service.BusinessObjectService;
import org.kuali.rice.krad.service.DocumentService;
import org.kuali.rice.krad.util.GlobalVariables;
import org.kuali.rice.krad.util.ObjectUtils;
import org.springframework.beans.BeanUtils;
@Entity
@Table(name = "TEM_TRVL_AUTH_DOC_T")
public class TravelAuthorizationDocument extends TravelDocumentBase implements PaymentSource, AmountTotaling {
protected static Logger LOG = Logger.getLogger(TravelAuthorizationDocument.class);
private KualiDecimal perDiemAdjustment;
// Emergency contact info section
private String cellPhoneNumber;
private String regionFamiliarity;
private List<TransportationModeDetail> transportationModes = new ArrayList<TransportationModeDetail>();
private TravelAdvance travelAdvance;
private TravelPayment advanceTravelPayment;
private PaymentSourceWireTransfer wireTransfer;
private List<TemSourceAccountingLine> advanceAccountingLines;
private List<TravelAdvance> travelAdvancesForTrip;
private Integer nextAdvanceLineNumber = new Integer(1);
private String holdRequestorprincipalId ;
protected volatile static PersonService personService;
protected volatile static ConfigurationService configurationService;
protected volatile static PaymentSourceHelperService paymentSourceHelperService;
protected volatile static OptionsService optionsService;
protected volatile static UniversityDateService universityDateService;
protected volatile static OffsetDefinitionService offsetDefinitionService;
/**
* Creates a new instance of the Travel Request Document. Initializes the empty arrays as well as the line tracking numbers
*/
public TravelAuthorizationDocument() {
super();
}
public TravelAuthorizationAmendmentDocument toCopyTAA() throws WorkflowException {
TravelAuthorizationAmendmentDocument doc = (TravelAuthorizationAmendmentDocument) SpringContext.getBean(DocumentService.class).getNewDocument(TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT);
toCopyTravelAuthorizationDocument(doc);
doc.setActualExpenses((List<ActualExpense>) getTravelDocumentService().copyActualExpenses(getActualExpenses(), doc.getDocumentNumber()));
doc.getDocumentHeader().setDocumentDescription(TemConstants.PRE_FILLED_DESCRIPTION);
doc.setApplicationDocumentStatus(TravelAuthorizationStatusCodeKeys.IN_PROCESS);
doc.initiateAdvancePaymentAndLines();
return doc;
}
/**
* Utility method which initiates the travel advance, hte wire transfer, the travel payment, and sets up all the related keys. Also, if the parameters are set for the advance accounting line, that is set up as
* well
*/
protected void initiateAdvancePaymentAndLines() {
setDefaultBankCode();
setTravelAdvance(new TravelAdvance());
getTravelAdvance().setDocumentNumber(getDocumentNumber());
setAdvanceTravelPayment(new TravelPayment());
getAdvanceTravelPayment().setDocumentNumber(getDocumentNumber());
getAdvanceTravelPayment().setDocumentationLocationCode(getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TravelParameters.DOCUMENTATION_LOCATION_CODE,
getParameterService().getParameterValueAsString(TemParameterConstants.TEM_DOCUMENT.class,TravelParameters.DOCUMENTATION_LOCATION_CODE)));
getAdvanceTravelPayment().setCheckStubText(getConfigurationService().getPropertyValueAsString(TemKeyConstants.MESSAGE_TA_ADVANCE_PAYMENT_HOLD_TEXT));
final java.sql.Date currentDate = getDateTimeService().getCurrentSqlDate();
getAdvanceTravelPayment().setDueDate(currentDate);
updatePayeeTypeForAuthorization(); // if the traveler is already initialized, set up payee type on advance travel payment
setWireTransfer(new PaymentSourceWireTransfer());
getWireTransfer().setDocumentNumber(getDocumentNumber());
setAdvanceAccountingLines(new ArrayList<TemSourceAccountingLine>());
resetNextAdvanceLineNumber();
TemSourceAccountingLine accountingLine = initiateAdvanceAccountingLine();
addAdvanceAccountingLine(accountingLine);
}
public TravelAuthorizationCloseDocument toCopyTAC() throws WorkflowException {
TravelAuthorizationCloseDocument doc = (TravelAuthorizationCloseDocument) SpringContext.getBean(DocumentService.class).getNewDocument(TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_CLOSE_DOCUMENT);
toCopyTravelAuthorizationDocument(doc);
doc.setActualExpenses((List<ActualExpense>) getTravelDocumentService().copyActualExpenses(getActualExpenses(), doc.getDocumentNumber()));
return doc;
}
/**
* Creates a TA which is a copy of this TAA document
*
* @return the copied TravelAuthorizationDocument
* @throws WorkflowException thrown if the new TA could not be correctly instantiated
*/
public TravelAuthorizationDocument toCopyTA() throws WorkflowException {
TravelAuthorizationDocument doc = (TravelAuthorizationDocument) SpringContext.getBean(DocumentService.class).getNewDocument(TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT);
toCopyTravelAuthorizationDocument(doc);
doc.getDocumentHeader().setDocumentDescription(TemConstants.PRE_FILLED_DESCRIPTION);
doc.getDocumentHeader().setOrganizationDocumentNumber("");
doc.setApplicationDocumentStatus(TravelAuthorizationStatusCodeKeys.IN_PROCESS);
doc.setTravelDocumentIdentifier(null); // reset, so it regenerates
doc.initiateAdvancePaymentAndLines();
return doc;
}
/**
*
* @param doc
* @param documentID
*/
protected void toCopyTravelAuthorizationDocument(TravelAuthorizationDocument copyToDocument) {
String documentID = copyToDocument.getDocumentNumber();
//copy over all possible elements from this self to TravelAuthorizationDocument except document header
BeanUtils.copyProperties(this, copyToDocument, new String[]{KFSConstants.DOCUMENT_HEADER_PROPERTY_NAME});
FinancialSystemDocumentHeader documentHeader = new FinancialSystemDocumentHeader();
documentHeader.setDocumentNumber(documentID);
BeanUtils.copyProperties(copyToDocument.getDocumentHeader(), documentHeader, new String[] {KFSPropertyConstants.DOCUMENT_NUMBER, KFSPropertyConstants.OBJECT_ID, KFSPropertyConstants.VERSION_NUMBER});
documentHeader.setOrganizationDocumentNumber(this.getDocumentHeader().getOrganizationDocumentNumber());
copyToDocument.setDocumentHeader(documentHeader);
copyToDocument.setTransportationModes(getTravelDocumentService().copyTransportationModeDetails(getTransportationModes(), documentID));
copyToDocument.setPerDiemExpenses(getTravelDocumentService().copyPerDiemExpenses(getPerDiemExpenses(), documentID));
copyToDocument.setSpecialCircumstances(getTravelDocumentService().copySpecialCircumstances(getSpecialCircumstances(), documentID));
copyToDocument.setTravelerDetailId(null);
copyToDocument.setTraveler(getTravelerService().copyTravelerDetail(getTraveler(), documentID));
copyToDocument.setGroupTravelers(getTravelDocumentService().copyGroupTravelers(getGroupTravelers(), documentID));
copyToDocument.setImportedExpenses(new ArrayList<ImportedExpense>());
copyToDocument.getNotes().clear();
copyToDocument.getDocumentHeader().setDocumentDescription(getDocumentHeader().getDocumentDescription());
copyToDocument.setTravelDocumentIdentifier(getTravelDocumentIdentifier());
copyToDocument.setDocumentNumber(documentID);
copyToDocument.setGeneralLedgerPendingEntries(new ArrayList<GeneralLedgerPendingEntry>());
//reset to only include the encumbrance line
List<TemSourceAccountingLine> newList = new ArrayList<TemSourceAccountingLine>();
int sequence = 1;
for (TemSourceAccountingLine line : copyToDocument.getEncumbranceSourceAccountingLines()){
line.setSequenceNumber(new Integer(sequence));
sequence++;
newList.add(line);
}
copyToDocument.setSourceAccountingLines(newList);
copyToDocument.setNextSourceLineNumber(new Integer(sequence));
copyToDocument.initiateAdvancePaymentAndLines();// should we be reinitiating all travel advance info here? Funcs will tell us if that's wrong....
}
/**
* cleans up the advance and accounting lines associated with it - those should be blank for the copy
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#toCopy()
*/
@Override
public void toCopy() throws WorkflowException {
super.toCopy();
travelAdvancesForTrip = null;
setTravelDocumentIdentifier(null);
if (!(this instanceof TravelAuthorizationCloseDocument)) { // TAC's don't have advances
initiateAdvancePaymentAndLines();
}
}
/**
* Determines if this document should do the extra work on a document copy associated with reverting to a TA document
* Of course, in this implementation, we return false always because a TA doesn't have to do the extra work. But TAA's and TAC's do.
* @return true if extra work should be done on document copy to revert to original authorization, false otherwise
*/
public boolean shouldRevertToOriginalAuthorizationOnCopy() {
return false;
}
/**
* Gets the perDiemAdjustment attribute.
*
* @return Returns the perDiemAdjustment.
*/
@Override
@Column(name = "PER_DIEM_ADJ", precision = 19, scale = 2)
public KualiDecimal getPerDiemAdjustment() {
return perDiemAdjustment == null?KualiDecimal.ZERO:perDiemAdjustment;
}
/**
* Sets the perDiemAdjustment attribute value.
*
* @param perDiemAdjustment The perDiemAdjustment to set.
*/
@Override
public void setPerDiemAdjustment(KualiDecimal perDiemAdjustment) {
this.perDiemAdjustment = perDiemAdjustment == null?KualiDecimal.ZERO:perDiemAdjustment;
}
/**
* This method returns the traveler's cell phone number
*
* @return cell phone of traveler
*/
@Column(name = "CELL_PH_NUM", length = 10)
public String getCellPhoneNumber() {
return cellPhoneNumber;
}
/**
* This method sets the cell phone of the traveler
*
* @param cellPhoneNumber
*/
public void setCellPhoneNumber(String cellPhoneNumber) {
this.cellPhoneNumber = cellPhoneNumber;
}
/**
* This method gets the traveler's familiarity with the region
*
* @return traveler's regional familiarity
*/
@Column(name = "rgn_famil")
public String getRegionFamiliarity() {
return regionFamiliarity;
}
/**
* This method sets the traveler's familiarity with the region
*
* @param regionFamiliarity
*/
public void setRegionFamiliarity(String regionFamiliarity) {
this.regionFamiliarity = regionFamiliarity;
}
@Override
@Transient
public List<TransportationModeDetail> getTransportationModes() {
return transportationModes;
}
/**
* This method sets the transportation modes
*
* @param transportationModes
*/
@Override
public void setTransportationModes(List<TransportationModeDetail> transportationModes) {
this.transportationModes = transportationModes;
}
/**
* Helper method to add a transportation mode detail to a Travel Request
*
* @param transportationModeDetail
*/
public void addTransportationMode(TransportationModeDetail transportationModeDetail) {
transportationModeDetail.setDocumentNumber(this.documentNumber);
this.transportationModes.add(transportationModeDetail);
}
/**
* This method populates the list of transportation modes from an array of strings
*
* @param selectedTransportationModes
*/
@Transient
public void setTransportationModeCodes(List<String> selectedTransportationModes) {
// now we need to lookup the corresponding transportation mode and add it
for (String string : selectedTransportationModes) {
// now we need to determine if this mode is already stored as a detail object
TransportationModeDetail detail = new TransportationModeDetail();
detail.setTransportationModeCode(string);
detail.setDocumentNumber(this.documentNumber);
if (!transportationModes.contains(detail)) {
this.addTransportationMode(detail);
}
}
// now for removed items
if (selectedTransportationModes.size() != this.transportationModes.size()) {
// need to figure out which items need to be removed from the transportation modes array
for (ListIterator<TransportationModeDetail> iter = transportationModes.listIterator(); iter.hasNext();) {
TransportationModeDetail detail = iter.next();
if (!selectedTransportationModes.contains(detail.getTransportationModeCode())) {
// we need to remove this item from collection (and OJB should manage the rest
iter.remove();
}
}
}
}
/**
* The toCopy method is forcing me to put in this method so it doesn't choke when trying to copy over
*/
@Transient
public List<String> getTransportationModeCodes() {
List<String> codes = new ArrayList<String>();
for (TransportationModeDetail mode : transportationModes) {
codes.add(mode.getTransportationModeCode());
}
return codes;
}
/**
* This method adds a new travel expense line to the managed collection
*
* @param travel expense line
*/
public void addActualExpenseLine(ActualExpense line) {
line.setDocumentLineNumber(getActualExpenses().size() + 1);
final String sequenceName = line.getSequenceName();
final Long sequenceNumber = getSequenceAccessorService().getNextAvailableSequenceNumber(sequenceName, ActualExpense.class);
line.setId(sequenceNumber);
line.setDocumentNumber(this.documentNumber);
notifyChangeListeners(new PropertyChangeEvent(this, TemPropertyConstants.ACTUAL_EXPENSES, null, line));
getActualExpenses().add(line);
logErrors();
}
/**
* @return the TravelAdvance associated with this document
*/
public TravelAdvance getTravelAdvance() {
return travelAdvance;
}
/**
* Sets the TravelAdvance associated with this document
* @param travelAdvance the Travel Advance for this document
*/
public void setTravelAdvance(TravelAdvance travelAdvance) {
this.travelAdvance = travelAdvance;
}
/**
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#initiateDocument()
*/
@Override
public void initiateDocument() {
super.initiateDocument();
setApplicationDocumentStatus(TravelAuthorizationStatusCodeKeys.IN_PROCESS);
this.tripProgenitor = true;
//always default trip begin/date
Calendar calendar = getDateTimeService().getCurrentCalendar();
calendar.add(Calendar.DAY_OF_MONTH, 1);
setTripBegin(new Timestamp(calendar.getTimeInMillis()));
calendar.add(Calendar.DAY_OF_MONTH, 2);
setTripEnd(new Timestamp(calendar.getTimeInMillis()));
initiateAdvancePaymentAndLines();
}
/**
* Initiates the accounting line to go with the advance if all the parameters for the advance are set
* @return the initiated accounting line
*/
protected TemSourceAccountingLine initiateAdvanceAccountingLine() {
try {
TemSourceAccountingLine accountingLine = getAdvanceAccountingLineClass().newInstance();
accountingLine.setDocumentNumber(getDocumentNumber());
accountingLine.setFinancialDocumentLineTypeCode(TemConstants.TRAVEL_ADVANCE_ACCOUNTING_LINE_TYPE_CODE);
accountingLine.setSequenceNumber(new Integer(1));
accountingLine.setCardType(TemConstants.ADVANCE);
if (this.allParametersForAdvanceAccountingLinesSet()) {
accountingLine.setChartOfAccountsCode(getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TemConstants.TravelAuthorizationParameters.TRAVEL_ADVANCE_CHART));
accountingLine.setAccountNumber(getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TemConstants.TravelAuthorizationParameters.TRAVEL_ADVANCE_ACCOUNT));
accountingLine.setFinancialObjectCode(getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TemConstants.TravelAuthorizationParameters.TRAVEL_ADVANCE_OBJECT_CODE));
}
return accountingLine;
}
catch (InstantiationException ie) {
LOG.error("Could not instantiate new advance accounting line of type: "+getAdvanceAccountingLineClass().getName());
throw new RuntimeException("Could not instantiate new advance accounting line of type: "+getAdvanceAccountingLineClass().getName(), ie);
}
catch (IllegalAccessException iae) {
LOG.error("Illegal access attempting to instantiate advance accounting line of class "+getAdvanceAccountingLineClass().getName());
throw new RuntimeException("Illegal access attempting to instantiate advance accounting line of class "+getAdvanceAccountingLineClass().getName(), iae);
}
}
/**
* Adds a new emergency contact line
*
* @param line
*/
public void addEmergencyContactLine(TravelerDetailEmergencyContact line) {
if (!ObjectUtils.isNull(getTraveler())) {
line.setFinancialDocumentLineNumber(getTraveler().getEmergencyContacts().size() + 1);
line.setDocumentNumber(this.documentNumber);
line.setTravelerDetailId(getTraveler().getId());
getTraveler().getEmergencyContacts().add(line);
}
}
public void addPerDiemExpensesLine(PerDiemExpense line) {
line.setDocumentNumber(this.documentNumber);
this.perDiemExpenses.add(line);
}
/**
* Determines if this document should be able to return to the fiscal officer node again. This can happen if the user has rights
* to reroute and also if the document is already ENROUTE.
*
* @return true if the document is currently enroute and reroutable
*/
@Override
public boolean canReturn() {
return getDocumentHeader().getWorkflowDocument().isEnroute();
}
@Override
@Transient
public KualiDecimal getEncumbranceTotal() {
TemExpenseService service = (TemExpenseService) SpringContext.getBean(TemExpense.class,TemConstants.TemExpenseTypes.PER_DIEM);
KualiDecimal encTotal = service.getAllExpenseTotal(this, false);
service = (TemExpenseService) SpringContext.getBean(TemExpense.class,TemConstants.TemExpenseTypes.ACTUAL);
encTotal = service.getAllExpenseTotal(this, false).add(encTotal);
if (ObjectUtils.isNotNull(this.perDiemAdjustment) && perDiemAdjustment.isPositive()) {
encTotal = encTotal.subtract(this.perDiemAdjustment);
}
final KualiDecimal encTotalWithExpenseLimit = applyExpenseLimit(encTotal);
return encTotalWithExpenseLimit;
}
/**
* @see org.kuali.kfs.sys.document.AccountingDocumentBase#customizeExplicitGeneralLedgerPendingEntry(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail,
* org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)
*/
@Override
public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) {
super.customizeExplicitGeneralLedgerPendingEntry(postable, explicitEntry);
if (postable instanceof AccountingLine) {
final AccountingLine accountingLine = (AccountingLine)postable;
if (TemConstants.TRAVEL_ADVANCE_ACCOUNTING_LINE_TYPE_CODE.equals(accountingLine.getFinancialDocumentLineTypeCode())) {
customizeAdvanceExplicitGeneralLedgerPendingEntry(postable, explicitEntry);
return; // just leave the method, we're done
}
}
customizeExpenseExplicitGeneralLedgerPendingEntry(postable, explicitEntry);
}
/**
* Customization for "normal" accounting lines - the accounting lines which will encumber
* @param postable the general ledger pending entry source which is the source of the customized explicit entry
* @param explicitEntry the explicit entry to customize
*/
protected void customizeExpenseExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) {
// set the encumbrance update code Set to ENCUMB_UPDT_REFERENCE_DOCUMENT_CD ("R")
explicitEntry.setTransactionEncumbranceUpdateCode(KFSConstants.ENCUMB_UPDT_REFERENCE_DOCUMENT_CD);
// set the offset entry to Debit "D"
explicitEntry.setTransactionDebitCreditCode(KFSConstants.GL_DEBIT_CODE);
explicitEntry.setDocumentNumber(this.getDocumentNumber());
String referenceDocumentNumber = this.getTravelDocumentIdentifier();
if (ObjectUtils.isNotNull(referenceDocumentNumber)) {
explicitEntry.setReferenceFinancialDocumentNumber(referenceDocumentNumber);
explicitEntry.setReferenceFinancialDocumentTypeCode(TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT);
explicitEntry.setReferenceFinancialSystemOriginationCode(TemConstants.ORIGIN_CODE);
}
String balanceType = getTravelEncumbranceService().getEncumbranceBalanceTypeByTripType(this);
if (StringUtils.isNotEmpty(balanceType)) {
explicitEntry.setFinancialBalanceTypeCode(balanceType);
}
explicitEntry.setOrganizationDocumentNumber(getTravelDocumentIdentifier());
}
/**
* Customization for accounting lines associated with travel advances
* @param postable the general ledger pending entry source which is the source of the customized explicit entry
* @param explicitEntry the explicit entry to customize
*/
protected void customizeAdvanceExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) {
final String paymentDocumentType = StringUtils.isBlank(getTravelAdvancePaymentDocumentType()) ? TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_CHECK_ACH_DOCUMENT : getTravelAdvancePaymentDocumentType();
explicitEntry.setFinancialDocumentTypeCode(paymentDocumentType);
final String description = MessageFormat.format(getConfigurationService().getPropertyValueAsString(TemKeyConstants.TA_MESSAGE_ADVANCE_ACCOUNTING_LINES_GLPE_DESCRIPTION), getDataDictionaryService().getDocumentTypeNameByClass(getClass()), getDocumentNumber());
final int maxLength = getDataDictionaryService().getAttributeMaxLength(GeneralLedgerPendingEntry.class, KFSPropertyConstants.TRANSACTION_LEDGER_ENTRY_DESC);
explicitEntry.setTransactionLedgerEntryDescription(StringUtils.abbreviate(description, maxLength));
explicitEntry.setOrganizationDocumentNumber(getTravelDocumentIdentifier());
}
/**
* @see org.kuali.kfs.sys.document.AccountingDocumentBase#customizeOffsetGeneralLedgerPendingEntry(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail,
* org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)
*/
@Override
public boolean customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry) {
boolean customized = super.customizeOffsetGeneralLedgerPendingEntry(accountingLine, explicitEntry, offsetEntry);
if (accountingLine instanceof AccountingLine) {
final AccountingLine postable = (AccountingLine)accountingLine;
if (TemConstants.TRAVEL_ADVANCE_ACCOUNTING_LINE_TYPE_CODE.equals(postable.getFinancialDocumentLineTypeCode())) {
return customized && customizeAdvanceOffsetGeneralLedgerPendingEntry(accountingLine, explicitEntry, offsetEntry);
}
}
return customized && customizeExpenseOffsetGeneralLedgerPendingEntry(accountingLine, explicitEntry, offsetEntry);
}
/**
* Customizes offset GLPE's for "normal" accounting lines which are offsetting entries which are paying off expenses
* @param accountingLine the general ledger pending entry source which acts as the source of the given offset entry to customize
* @param explicitEntry the explicit GLPE which needs to be offset
* @param offsetEntry the offset GLPE which is being customized
* @return true if customization has completed successfully, false otherwise
*/
public boolean customizeExpenseOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry) {
boolean customized = false;
// set the encumbrance update code
offsetEntry.setTransactionEncumbranceUpdateCode(KFSConstants.ENCUMB_UPDT_REFERENCE_DOCUMENT_CD);
// set the offset entry to Credit "C"
offsetEntry.setTransactionDebitCreditCode(KFSConstants.GL_CREDIT_CODE);
offsetEntry.setDocumentNumber(this.getDocumentNumber());
String referenceDocumentNumber = this.getTravelDocumentIdentifier();
if (ObjectUtils.isNotNull(referenceDocumentNumber)) {
offsetEntry.setReferenceFinancialDocumentNumber(referenceDocumentNumber);
offsetEntry.setReferenceFinancialDocumentTypeCode(TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT);
offsetEntry.setReferenceFinancialSystemOriginationCode(TemConstants.ORIGIN_CODE);
}
String balanceType = getTravelEncumbranceService().getEncumbranceBalanceTypeByTripType(this);
if (StringUtils.isNotEmpty(balanceType)) {
offsetEntry.setFinancialBalanceTypeCode(balanceType);
customized = true;
}
offsetEntry.setOrganizationDocumentNumber(getTravelDocumentIdentifier());
return customized;
}
/**
* Customizes offset GLPE's for accounting lines associated with advances
* @param accountingLine the general ledger pending entry source which acts as the source of the given offset entry to customize
* @param explicitEntry the explicit GLPE which needs to be offset
* @param offsetEntry the offset GLPE which is being customized
* @return true if customization has completed successfully, false otherwise
*/
public boolean customizeAdvanceOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry) {
final String paymentDocumentType = StringUtils.isBlank(getTravelAdvancePaymentDocumentType()) ? TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_CHECK_ACH_DOCUMENT : getTravelAdvancePaymentDocumentType();
offsetEntry.setFinancialDocumentTypeCode(paymentDocumentType);
offsetEntry.setOrganizationDocumentNumber(getTravelDocumentIdentifier());
return true;
}
/**
* @return the document type associated with the travel payment for the advance on this document
*/
public String getTravelAdvancePaymentDocumentType() {
if (shouldProcessAdvanceForDocument()) {
if (KFSConstants.PaymentSourceConstants.PAYMENT_METHOD_CHECK.equals(getAdvanceTravelPayment().getPaymentMethodCode())) {
return TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_CHECK_ACH_DOCUMENT;
} else if (KFSConstants.PaymentSourceConstants.PAYMENT_METHOD_DRAFT.equals(getAdvanceTravelPayment().getPaymentMethodCode()) || KFSConstants.PaymentSourceConstants.PAYMENT_METHOD_WIRE.equals(getAdvanceTravelPayment().getPaymentMethodCode())) {
return TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_WIRE_OR_FOREIGN_DRAFT_DOCUMENT;
}
}
return KFSConstants.EMPTY_STRING;
}
/**
*
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#generateDocumentGeneralLedgerPendingEntries(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)
*/
@Override
public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) {
if (TemConstants.TravelAuthorizationStatusCodeKeys.CLOSED.equals(getAppDocStatus()) || TemConstants.TravelAuthorizationStatusCodeKeys.CANCELLED.equals(getAppDocStatus())) {
return true; // we're closed or cancelled. skip normal entry generation
}
boolean success = super.generateDocumentGeneralLedgerPendingEntries(sequenceHelper);
if (shouldProcessAdvanceForDocument() && getTravelAdvance().getTravelAdvanceRequested() != null) {
// generate wire entries
if (!StringUtils.isBlank(getAdvanceTravelPayment().getPaymentMethodCode())) {
if (KFSConstants.PaymentSourceConstants.PAYMENT_METHOD_WIRE.equals(getAdvanceTravelPayment().getPaymentMethodCode()) && !getWireTransfer().isWireTransferFeeWaiverIndicator()) {
LOG.debug("generating wire charge gl pending entries.");
// retrieve wire charge
WireCharge wireCharge = getPaymentSourceHelperService().retrieveWireChargeForDate(getTravelAdvance().getDueDate());
if (wireCharge == null) {
wireCharge = getPaymentSourceHelperService().retrieveCurrentYearWireCharge();
}
// generate debits
GeneralLedgerPendingEntry chargeEntry = getPaymentSourceHelperService().processWireChargeDebitEntries(this, sequenceHelper, wireCharge);
// generate credits
getPaymentSourceHelperService().processWireChargeCreditEntries(this, sequenceHelper, wireCharge, chargeEntry);
}
// for wire or drafts generate bank offset entry (if enabled), for ACH and checks offset will be generated by PDP
if (KFSConstants.PaymentSourceConstants.PAYMENT_METHOD_WIRE.equals(getAdvanceTravelPayment().getPaymentMethodCode()) || KFSConstants.PaymentSourceConstants.PAYMENT_METHOD_DRAFT.equals(getAdvanceTravelPayment().getPaymentMethodCode())) {
getPaymentSourceHelperService().generateDocumentBankOffsetEntries(this, sequenceHelper, TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_WIRE_OR_FOREIGN_DRAFT_DOCUMENT, getTravelAdvance().getTravelAdvanceRequested().negated());
}
}
// generate entries for advance accounting lines
if (!GlobalVariables.getMessageMap().hasErrors()) {
// skip generation of advance accounting line if any errors exist on the document
for (TemSourceAccountingLine advanceAccountingLine : getAdvanceAccountingLines()) {
generateGeneralLedgerPendingEntries(advanceAccountingLine, sequenceHelper);
sequenceHelper.increment();
}
}
}
return success;
}
/**
* @see org.kuali.rice.kns.document.Document#doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChange)
*/
@Override
public void doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent) {
super.doRouteStatusChange(statusChangeEvent);
if (DocumentStatus.PROCESSED.getCode().equals(statusChangeEvent.getNewRouteStatus())) {
LOG.debug("New route status is " + statusChangeEvent.getNewRouteStatus());
this.getDocumentHeader().setOrganizationDocumentNumber(getTravelDocumentIdentifier());
if (!(this instanceof TravelAuthorizationCloseDocument)) {
// for some reason when it goes to final it never updates to the last status, updating TA status to OPEN REIMBURSEMENT
try {
updateAndSaveAppDocStatus(TravelAuthorizationStatusCodeKeys.OPEN_REIMB);
}
catch (WorkflowException ex) {
// TODO Auto-generated catch block
ex.printStackTrace();
}
getTravelAuthorizationService().createCustomerInvoice(this);
//If the hold new fiscal year encumbrance indicator is true and the trip end date is after the current fiscal year end date then mark all the gl pending entries
//as 'H' (Hold) otherwise mark all the gl pending entries as 'A' (approved)
if (getGeneralLedgerPendingEntries() != null && !getGeneralLedgerPendingEntries().isEmpty()) {
if(getParameterService().getParameterValueAsBoolean(TravelAuthorizationDocument.class, TravelAuthorizationParameters.HOLD_NEW_FISCAL_YEAR_ENCUMBRANCES_IND)) {
List<GeneralLedgerPendingEntry> survivingEntries = new ArrayList<GeneralLedgerPendingEntry>();
List<HeldEncumbranceEntry> heldEntries = new ArrayList<HeldEncumbranceEntry>();
final boolean shouldHoldEncumbrance = shouldHoldEncumbrance();
final boolean shouldHoldAdvance = shouldHoldAdvance();
for(GeneralLedgerPendingEntry glpe : getGeneralLedgerPendingEntries()) {
if (((shouldHoldEncumbrance && isEncumbrancePendingEntry(glpe)) || (shouldHoldAdvance && isAdvancePendingEntry(glpe)))) {
if (!glpe.isTransactionEntryOffsetIndicator()) {
HeldEncumbranceEntry hee = getTravelEncumbranceService().convertPendingEntryToHeldEncumbranceEntry(glpe);
heldEntries.add(hee);
}
getBusinessObjectService().delete(glpe);
} else {
glpe.setFinancialDocumentApprovedCode(KFSConstants.DocumentStatusCodes.APPROVED); // we shouldn't hit this block but if for some weird reason we do, let's approve the glpe
survivingEntries.add(glpe);
}
}
if (!heldEntries.isEmpty()) {
getBusinessObjectService().save(heldEntries);
}
setGeneralLedgerPendingEntries(survivingEntries);
} else {
for (GeneralLedgerPendingEntry glpe : getGeneralLedgerPendingEntries()) {
glpe.setFinancialDocumentApprovedCode(KFSConstants.DocumentStatusCodes.APPROVED);
}
}
SpringContext.getBean(BusinessObjectService.class).save(getGeneralLedgerPendingEntries());
}
if (shouldProcessAdvanceForDocument() && this.getAdvanceTravelPayment().isImmediatePaymentIndicator()) {
SpringContext.getBean(PaymentSourceExtractionService.class, TemConstants.AUTHORIZATION_PAYMENT_SOURCE_EXTRACTION_SERVICE).extractSingleImmediatePayment(this);
}
}
}
}
/**
* Determines if this document should hold its encumbrances because the trip end date belongs to a fiscal year which does not yet exist
* @return true if we should hold encumbrances, false otherwise
*/
protected boolean shouldHoldEncumbrance() {
if (getTripEnd() == null) {
return false; // we won't hold encumbrances if we don't know when the trip is ending
}
final java.sql.Date tripEnd = new java.sql.Date(getTripEnd().getTime());
return getTravelEncumbranceService().shouldHoldEntries(tripEnd);
}
/**
* Determines if this document has an advance and the due date for the advance occurs in a non-existing fiscal year, in which case, the advance's glpes should be held
* @return true if we should hold advance entries, false otherwise
*/
protected boolean shouldHoldAdvance() {
if (shouldProcessAdvanceForDocument() && getTravelAdvance().getDueDate() != null) {
return getTravelEncumbranceService().shouldHoldEntries(getTravelAdvance().getDueDate());
}
return false;
}
/**
* Determines if the given general ledger pending entry represents an encumbrance entry
* @param glpe pending entry to test
* @return true if the pending entry represents an encumbrance, false otherwise
*/
protected boolean isEncumbrancePendingEntry(GeneralLedgerPendingEntry glpe) {
return StringUtils.equals(glpe.getFinancialDocumentTypeCode(), TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT) ||
StringUtils.equals(glpe.getFinancialDocumentTypeCode(), TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT) ||
StringUtils.equals(glpe.getFinancialDocumentTypeCode(), TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_CLOSE_DOCUMENT);
}
/**
* Determines if the given pending entry represents an advance
* @param glpe the pending entry to test
* @return true if the pending entry represents an advance, false otherwise
*/
protected boolean isAdvancePendingEntry(GeneralLedgerPendingEntry glpe) {
return StringUtils.equals(glpe.getFinancialDocumentTypeCode(), TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_CHECK_ACH_DOCUMENT) ||
StringUtils.equals(glpe.getFinancialDocumentTypeCode(),TemConstants.TravelDocTypes.TRAVEL_AUTHORIZATION_WIRE_OR_FOREIGN_DRAFT_DOCUMENT);
}
/**
* Sets the doc status for previous authorizations to "Retired"
*/
protected void retirePreviousAuthorizations() {
List<Document> relatedDocs = getTravelDocumentService().getDocumentsRelatedTo(this, TravelDocTypes.TRAVEL_AUTHORIZATION_DOCUMENT,
TravelDocTypes.TRAVEL_AUTHORIZATION_AMEND_DOCUMENT);
//updating the related's document appDocStatus to be retired
final DocumentAttributeIndexingQueue documentAttributeIndexingQueue = KewApiServiceLocator.getDocumentAttributeIndexingQueue();
try {
for (Document document : relatedDocs){
if (!document.getDocumentNumber().equals(this.getDocumentNumber())) {
((TravelAuthorizationDocument) document).updateAndSaveAppDocStatus(TravelAuthorizationStatusCodeKeys.RETIRED_VERSION);
documentAttributeIndexingQueue.indexDocument(document.getDocumentNumber());
}
}
}
catch (WorkflowException we) {
throw new RuntimeException("Workflow document exception while updating related documents", we);
}
}
/**
* NOTE: need to find out all reference to TA's source accounting lines
*
* @see org.kuali.kfs.sys.document.AccountingDocumentBase#getSourceAccountingLines()
*/
@Override
public List getSourceAccountingLines() {
return super.getSourceAccountingLines();
}
/**
* Get all of the encumbrance source accounting lines (for estimated expenses) - do not include any import
* expense lines
*
* @return
*/
public List<TemSourceAccountingLine> getEncumbranceSourceAccountingLines() {
List<TemSourceAccountingLine> encumbranceLines = new ArrayList<TemSourceAccountingLine>();
for (TemSourceAccountingLine line : (List<TemSourceAccountingLine>) getSourceAccountingLines()){
if (TemConstants.ENCUMBRANCE.equals(line.getCardType())){
encumbranceLines.add(line);
}
}
return encumbranceLines;
}
/**
* Only return something if the document is not closed or cancelled
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#getGeneralLedgerPendingEntrySourceDetails()
*/
@Override
public List<GeneralLedgerPendingEntrySourceDetail> getGeneralLedgerPendingEntrySourceDetails() {
if (TemConstants.TravelAuthorizationStatusCodeKeys.CLOSED.equals(getAppDocStatus()) || TemConstants.TravelAuthorizationStatusCodeKeys.CANCELLED.equals(getAppDocStatus())) {
return new ArrayList<GeneralLedgerPendingEntrySourceDetail>(); // hey, we're closed or cancelled. Let's not generate entries
}
return super.getGeneralLedgerPendingEntrySourceDetails();
}
/**
* @return the payment for advances on this document
*/
public TravelPayment getAdvanceTravelPayment() {
return advanceTravelPayment;
}
/**
* Sets the payment information for advances on this document
* @param advanceTravelPayment the payment information for advances on this document
*/
public void setAdvanceTravelPayment(TravelPayment advanceTravelPayment) {
this.advanceTravelPayment = advanceTravelPayment;
}
/**
* @return the accounting lines associated with advances on this document
*/
public List<TemSourceAccountingLine> getAdvanceAccountingLines() {
return advanceAccountingLines;
}
/**
* Sets accounting lines associated with advances on this document
* @param advanceAccountingLines the travel advance accounting lines
*/
public void setAdvanceAccountingLines(List<TemSourceAccountingLine> advanceAccountingLines) {
this.advanceAccountingLines = advanceAccountingLines;
}
/**
* This implementation sets the sequence number appropriately for the passed in source accounting line using the value that has
* been stored in the nextSourceLineNumber variable, adds the accounting line to the list that is aggregated by this object, and
* then handles incrementing the nextSourceLineNumber variable for you.
*/
public void addAdvanceAccountingLine(TemSourceAccountingLine line) {
line.setSequenceNumber(this.getNextAdvanceLineNumber());
this.advanceAccountingLines.add(line);
this.nextAdvanceLineNumber = new Integer(getNextAdvanceLineNumber().intValue() + 1);
}
/**
* This implementation is coupled tightly with some underlying issues that the Struts PojoProcessor plugin has with how objects
* get instantiated within lists. The first three lines are required otherwise when the PojoProcessor tries to automatically
* inject values into the list, it will get an index out of bounds error if the instance at an index is being called and prior
* instances at indices before that one are not being instantiated. So changing the code below will cause adding lines to break
* if you add more than one item to the list.
*/
public TemSourceAccountingLine getAdvanceAccountingLine(int index) {
while (getAdvanceAccountingLines().size() <= index) {
getAdvanceAccountingLines().add(createNewAdvanceAccountingLine());
}
return getAdvanceAccountingLines().get(index);
}
/**
* Creates a new, properly-initiated accounting line of the advance accounting line class specified on the Travel Authorization document
* @return a new accounting line for travel advances
*/
public TemSourceAccountingLine createNewAdvanceAccountingLine() {
try {
TemSourceAccountingLine accountingLine = getAdvanceAccountingLineClass().newInstance();
accountingLine.setFinancialDocumentLineTypeCode(TemConstants.TRAVEL_ADVANCE_ACCOUNTING_LINE_TYPE_CODE);
accountingLine.setCardType(TemConstants.ADVANCE); // really, card type is ignored but it is validated so we have to set something
accountingLine.setFinancialObjectCode(this.getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TemConstants.TravelAuthorizationParameters.TRAVEL_ADVANCE_OBJECT_CODE, KFSConstants.EMPTY_STRING));
return accountingLine;
}
catch (IllegalAccessException iae) {
throw new RuntimeException("unable to create a new source accounting line for advances", iae);
}
catch (InstantiationException ie) {
throw new RuntimeException("unable to create a new source accounting line for advances", ie);
}
}
/**
* @return the class associated with advances accounting lines
*/
public Class<? extends TemSourceAccountingLine> getAdvanceAccountingLineClass() {
return TemSourceAccountingLine.class;
}
/**
* @return the next available accounting line number for advances accounting lines
*/
public Integer getNextAdvanceLineNumber() {
return this.nextAdvanceLineNumber;
}
/**
* Method which resets the next next advance accounting line number back to 1; it should only be called by internal methods
* (like that which creates TAA's)
*/
protected void resetNextAdvanceLineNumber() {
this.nextAdvanceLineNumber = new Integer(1);
}
/**
* @return the total of the advance accounting lines
*/
public KualiDecimal getAdvanceTotal() {
KualiDecimal total = KualiDecimal.ZERO;
for (TemSourceAccountingLine accountingLine : getAdvanceAccountingLines()) {
if (accountingLine.getAmount() != null) {
total = total.add(accountingLine.getAmount());
}
}
return total;
}
/**
* Provides answers to the following splits: PurchaseWasReceived VendorIsEmployeeOrNonResidentAlien
*
* @see org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase#answerSplitNodeQuestion(java.lang.String)
*/
@Override
public boolean answerSplitNodeQuestion(String nodeName) throws UnsupportedOperationException {
if (nodeName.equals(TemWorkflowConstants.SPECIAL_REQUEST)) {
return requiresSpecialRequestReviewRouting();
}
if (nodeName.equals(TemWorkflowConstants.INTL_TRAVEL)) {
return requiresInternationalTravelReviewRouting();
}
if (nodeName.equals(TemWorkflowConstants.RISK_MANAGEMENT)) {
return requiresRiskManagementReviewRouting();
}
if (nodeName.equals(TemWorkflowConstants.TRVL_ADV_REQUESTED)) {
return requiresTravelAdvanceReviewRouting();
}
if (nodeName.equals(TemWorkflowConstants.DIVISION_APPROVAL_REQUIRED)) {
return requiresDivisionApprovalRouting();
}
if (nodeName.equals(TemWorkflowConstants.REQUIRES_TRAVELER_REVIEW)) {
return requiresTravelerApprovalRouting();
}
if (StringUtils.equals(TemWorkflowConstants.REQUIRES_BUDGET_REVIEW, nodeName)) {
return isBudgetReviewRequired();
}
if (nodeName.equals(TemWorkflowConstants.SEPARATION_OF_DUTIES)) {
return requiresSeparationOfDutiesRouting();
}
throw new UnsupportedOperationException("Cannot answer split question for this node you call \"" + nodeName + "\"");
}
/**
* Traveler approval is required if it requires review for travel advance
*
* @return
*/
public boolean requiresTravelerApprovalRouting() {
return getTravelDocumentService().requiresTravelerApproval(this);
}
/**
*
* @return
*/
public boolean requiresTravelAdvanceReviewRouting() {
return (shouldProcessAdvanceForDocument() && getTravelAdvance().getTravelAdvanceRequested().isPositive());
}
/**
* This method checks to see if Risk Management needs to be routed
*
* @return
*/
public boolean requiresRiskManagementReviewRouting() {
// Right now this works just like International Travel Reviewer, but may change for next version
if (ObjectUtils.isNotNull(this.getTripTypeCode()) && getParameterService().getParameterValuesAsString(TemParameterConstants.TEM_DOCUMENT.class, TravelParameters.INTERNATIONAL_TRIP_TYPES).contains(this.getTripTypeCode())) {
return true;
}
if (!ObjectUtils.isNull(getTraveler()) && getTraveler().isLiabilityInsurance()) {
return true;
}
return false;
}
/**
* @see org.kuali.rice.kns.document.DocumentBase#postProcessSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent)
*/
@Override
public void postProcessSave(KualiDocumentEvent event) {
super.postProcessSave(event);
}
/**
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#setTemProfile(org.kuali.kfs.module.tem.businessobject.TemProfile)
*/
@Override
public void setTemProfile(TemProfile temProfile) {
super.setTemProfile(temProfile);
if (!ObjectUtils.isNull(getTravelAdvance())) {
getTravelAdvance().setTravelAdvancePolicy(false);
}
}
/**
* @see org.kuali.rice.kns.document.DocumentBase#logErrors()
*/
@Override
public void logErrors() {
super.logErrors();
}
protected TravelAuthorizationService getTravelAuthorizationService() {
return SpringContext.getBean(TravelAuthorizationService.class);
}
/**
* @see org.kuali.rice.kns.document.DocumentBase#buildListOfDeletionAwareLists()
*/
@SuppressWarnings("rawtypes")
@Override
public List buildListOfDeletionAwareLists() {
List managedLists = super.buildListOfDeletionAwareLists();
//m2 removed this one managedLists.add(getPerDiemExpenses());
managedLists.add(getTransportationModes());
return managedLists;
}
/**
*
* @see org.kuali.kfs.module.tem.document.TravelDocument#getReimbursableTotal()
* This method is used for accounting line validation.
*/
@Override
public KualiDecimal getReimbursableTotal() {
return getEncumbranceTotal();
}
@Override
public String getReportPurpose() {
return getTripDescription();
}
@Override
public void populateVendorPayment(DisbursementVoucherDocument disbursementVoucherDocument) {
super.populateVendorPayment(disbursementVoucherDocument);
String locationCode = getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TravelParameters.DOCUMENTATION_LOCATION_CODE, getParameterService().getParameterValueAsString(TemParameterConstants.TEM_DOCUMENT.class,TravelParameters.DOCUMENTATION_LOCATION_CODE));
String startDate = new SimpleDateFormat("MM/dd/yyyy").format(this.getTripBegin());
String endDate = new SimpleDateFormat("MM/dd/yyyy").format(this.getTripEnd());
String checkStubText = this.getTravelDocumentIdentifier() + ", " + this.getPrimaryDestinationName() + ", " + startDate + " - " + endDate;
disbursementVoucherDocument.setDisbursementVoucherDocumentationLocationCode(locationCode);
disbursementVoucherDocument.setDisbVchrCheckStubText(checkStubText);
}
/**
* @see org.kuali.kfs.module.tem.document.TravelDocument#getExpenseTypeCode()
*/
@Override
public String getDefaultCardTypeCode() {
return isTripGenerateEncumbrance()? TemConstants.ENCUMBRANCE : "";
}
/**
* @see org.kuali.kfs.module.tem.document.TravelDocument#hasCustomDVDistribution()
*/
@Override
public boolean hasCustomDVDistribution(){
return true;
}
/**
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#getDisapprovedAppDocStatusMap()
*/
@Override
public Map<String, String> getDisapprovedAppDocStatusMap() {
return TravelAuthorizationStatusCodeKeys.getDisapprovedAppDocStatusMap();
}
/**
* If the line is for an advance, always returns true; otherwise, always returns false
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#isDebit(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)
*/
@Override
public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable) {
if (postable instanceof AccountingLine && TemConstants.TRAVEL_ADVANCE_ACCOUNTING_LINE_TYPE_CODE.equals(((AccountingLine)postable).getFinancialDocumentLineTypeCode())) {
return true; // we're an advance accounting line? then we're debiting...
}
return false; // we're not an advance accounting line? then we should return false...
}
/**
* Set the document number and the trip id on our travel advance
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent)
*/
@Override
public void prepareForSave(KualiDocumentEvent event) {
super.prepareForSave(event);
if (!(this instanceof TravelAuthorizationCloseDocument)) {
if (!ObjectUtils.isNull(getTravelAdvance())) {
getTravelAdvance().setTravelDocumentIdentifier(getTravelDocumentIdentifier());
final String checkStubPrefix = getConfigurationService().getPropertyValueAsString(TemKeyConstants.MESSAGE_TA_ADVANCE_PAYMENT_CHECK_TEXT_PREFIX);
getAdvanceTravelPayment().setCheckStubText(checkStubPrefix+" "+getDocumentHeader().getDocumentDescription());
getAdvanceTravelPayment().setDueDate(getTravelAdvance().getDueDate());
getAdvanceTravelPayment().setDocumentNumber(getDocumentNumber()); // this should already be set but no harm in resetting...
updatePayeeTypeForAuthorization();
}
}
if(maskTravelDocumentIdentifierAndOrganizationDocNumber()) {
this.getDocumentHeader().setOrganizationDocumentNumber(null);
}
}
/**
* For reimbursable documents, sets the proper payee type code and profile id after a profile lookup
* @param document the reimbursable document to update
*/
public void updatePayeeTypeForAuthorization() {
if (!ObjectUtils.isNull(getTraveler()) && !ObjectUtils.isNull(getAdvanceTravelPayment())) {
if (getTravelerService().isEmployee(getTraveler())){
getAdvanceTravelPayment().setPayeeTypeCode(KFSConstants.PaymentPayeeTypes.EMPLOYEE);
}else{
getAdvanceTravelPayment().setPayeeTypeCode(KFSConstants.PaymentPayeeTypes.CUSTOMER);
}
}
}
/**
* Returns the WireTransfer associated with this travel authorization
* @see org.kuali.kfs.sys.document.PaymentSource#getWireTransfer()
*/
@Override
public PaymentSourceWireTransfer getWireTransfer() {
return wireTransfer;
}
/**
* Sets the wire transfer for this travel authorization
* @param wireTransfer the wire transfer for this travel authorization
*/
public void setWireTransfer(PaymentSourceWireTransfer wireTransfer) {
this.wireTransfer = wireTransfer;
}
/**
* @return true if this document seems to have an active advance which should therefore be processed, false otherwise
*/
public boolean shouldProcessAdvanceForDocument() {
return !ObjectUtils.isNull(getTravelAdvance()) && getTravelAdvance().isAtLeastPartiallyFilledIn();
}
/**
* Returns the cancel date from the travel payment
* @see org.kuali.kfs.sys.document.PaymentSource#getCancelDate()
*/
public Date getCancelDate() {
return this.getAdvanceTravelPayment().getCancelDate();
}
/**
* Returns the attachment code from the travel payment
* @see org.kuali.kfs.sys.document.PaymentSource#hasAttachment()
*/
@Override
public boolean hasAttachment() {
return this.getAdvanceTravelPayment().isAttachmentCode();
}
/**
* Returns the payment method code associated with the travel payment for the advance
* @see org.kuali.kfs.sys.document.PaymentSource#getPaymentMethodCode()
*/
@Override
public String getPaymentMethodCode() {
return this.getAdvanceTravelPayment().getPaymentMethodCode();
}
/**
* Returns the campus code of the initiator of this document
* @see org.kuali.kfs.sys.document.PaymentSource#getCampusCode()
*/
@Override
public String getCampusCode() {
final Person initiator = getPersonService().getPerson(getDocumentHeader().getWorkflowDocument().getInitiatorPrincipalId());
return initiator.getCampusCode();
}
/**
* Determines whether the parameters which fill in the advance accounting line are set
* @return true if the parameters for the advance's accounting lines chart and account are set; false otherwise
*/
public boolean allParametersForAdvanceAccountingLinesSet() {
// not checking the object code because that will need to be set no matter what - every advance accounting line will use that
return (!StringUtils.isBlank(getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TemConstants.TravelAuthorizationParameters.TRAVEL_ADVANCE_ACCOUNT, KFSConstants.EMPTY_STRING)) &&
!StringUtils.isBlank(getParameterService().getParameterValueAsString(TravelAuthorizationDocument.class, TemConstants.TravelAuthorizationParameters.TRAVEL_ADVANCE_CHART, KFSConstants.EMPTY_STRING)));
}
/**
* Propagates the amount from the advance to the travel payment and to the accounting line if the accounting line is read only
*/
public void propagateAdvanceInformationIfNeeded() {
if (!ObjectUtils.isNull(getTravelAdvance()) && getTravelAdvance().getTravelAdvanceRequested() != null) {
if (!ObjectUtils.isNull(getAdvanceTravelPayment())) {
getAdvanceTravelPayment().setCheckTotalAmount(getTravelAdvance().getTravelAdvanceRequested());
}
final TemSourceAccountingLine maxAmountLine = getAccountingLineWithLargestAmount();
if (!TemConstants.TravelStatusCodeKeys.AWAIT_FISCAL.equals(getFinancialSystemDocumentHeader().getApplicationDocumentStatus())) {
getAdvanceAccountingLines().get(0).setAmount(getTravelAdvance().getTravelAdvanceRequested());
}
if (!allParametersForAdvanceAccountingLinesSet() && !TemConstants.TravelStatusCodeKeys.AWAIT_FISCAL.equals(getFinancialSystemDocumentHeader().getApplicationDocumentStatus()) && !advanceAccountingLinesHaveBeenModified(maxAmountLine)) {
// we need to set chart, account, sub-account, and sub-object from account with largest amount from regular source lines
if (maxAmountLine != null) {
getAdvanceAccountingLines().get(0).setChartOfAccountsCode(maxAmountLine.getChartOfAccountsCode());
getAdvanceAccountingLines().get(0).setAccountNumber(maxAmountLine.getAccountNumber());
getAdvanceAccountingLines().get(0).setSubAccountNumber(maxAmountLine.getSubAccountNumber());
}
}
// let's also propogate the due date
if (getTravelAdvance().getDueDate() != null && !ObjectUtils.isNull(getAdvanceTravelPayment())) {
getAdvanceTravelPayment().setDueDate(getTravelAdvance().getDueDate());
}
}
}
/**
* @return the source accounting line on this document with the largest amount
*/
protected TemSourceAccountingLine getAccountingLineWithLargestAmount() {
if (getSourceAccountingLines() == null || getSourceAccountingLines().isEmpty()) {
return null;
}
TemSourceAccountingLine max = (TemSourceAccountingLine)getSourceAccountingLines().get(0);
int count = 1;
while (count < getSourceAccountingLines().size()) {
TemSourceAccountingLine curr = (TemSourceAccountingLine)getSourceAccountingLines().get(count);
if (curr.getAmount().isGreaterThan(max.getAmount())) {
max = curr;
}
count += 1;
}
return max;
}
/**
* @return true if we think the fiscal officer modified the accounting lines, false otherwise
*/
protected boolean advanceAccountingLinesHaveBeenModified(TemSourceAccountingLine maxAmountLine) {
if (getAdvanceAccountingLines() == null || getAdvanceAccountingLines().isEmpty()) {
return true; // just skip out
}
if (getAdvanceAccountingLines().size() > 1) {
return true; // we have more than one accounting line? Then the fiscal officer must have modified
}
// so we've got one accounting line. Does its chart, account and sub-account match the source line with the most amount?
if (maxAmountLine == null) {
return false; // only fiscal officers can change lines - and without source accounting lines, we couldn't have gotten that far yet...so, no, the advance accounting lines haven't been modified
}
return StringUtils.equals(getAdvanceAccountingLines().get(0).getChartOfAccountsCode(), maxAmountLine.getChartOfAccountsCode()) && StringUtils.equals(getAdvanceAccountingLines().get(0).getAccountNumber(), maxAmountLine.getAccountNumber()) && StringUtils.equals(getAdvanceAccountingLines().get(0).getSubAccountNumber(), maxAmountLine.getSubAccountNumber());
}
/**
* Generate events for advance accounting lines
* @see org.kuali.kfs.sys.document.AccountingDocumentBase#generateSaveEvents()
*/
@Override
public List generateSaveEvents() {
List events = super.generateSaveEvents();
if (!ObjectUtils.isNull(getTravelAdvance()) && getTravelAdvance().isAtLeastPartiallyFilledIn() && !(getDocumentHeader().getWorkflowDocument().isInitiated() || getDocumentHeader().getWorkflowDocument().isSaved())) {
// only check advance accounting lines if the travel advance is filled in
final List<TemSourceAccountingLine> persistedAdvanceAccountingLines = getPersistedAdvanceAccountingLinesForComparison();
final List<TemSourceAccountingLine> currentAdvanceAccountingLines = getAdvanceAccountingLinesForComparison();
final List advanceEvents = generateEventsForAdvanceAccountingLines(persistedAdvanceAccountingLines, currentAdvanceAccountingLines);
events.addAll(advanceEvents);
}
return events;
}
/**
* Generates a List of events for advance accounting lines. UpdateAccountingLine events will never be generated - only ReviewAccountingLine, AddAccountingLine, and DeleteAccountingLine events;
* this way, we never check accessibility for advance accounting lines which is something that isn't really needed
* @param persistedAdvanceAccountingLines the persisted advance accounting lines
* @param currentAdvanceAccountingLines the current advance accounting lines
* @return a List of events
*/
protected List generateEventsForAdvanceAccountingLines(List<TemSourceAccountingLine> persistedAdvanceAccountingLines, List<TemSourceAccountingLine> currentAdvanceAccountingLines) {
List events = new ArrayList();
Map persistedLineMap = buildAccountingLineMap(persistedAdvanceAccountingLines);
final String errorPathPrefix = KFSConstants.DOCUMENT_PROPERTY_NAME + "." + TemPropertyConstants.ADVANCE_ACCOUNTING_LINES;
final String groupErrorPathPrefix = errorPathPrefix + KFSConstants.ACCOUNTING_LINE_GROUP_SUFFIX;
// (iterate through current lines to detect additions and updates, removing affected lines from persistedLineMap as we go
// so deletions can be detected by looking at whatever remains in persistedLineMap)
int index = 0;
for (TemSourceAccountingLine currentLine : currentAdvanceAccountingLines) {
String indexedErrorPathPrefix = errorPathPrefix + "[" + index + "]";
Integer key = currentLine.getSequenceNumber();
AccountingLine persistedLine = (AccountingLine) persistedLineMap.get(key);
if (persistedLine != null) {
ReviewAccountingLineEvent reviewEvent = new ReviewAccountingLineEvent(indexedErrorPathPrefix, this, currentLine);
events.add(reviewEvent);
persistedLineMap.remove(key);
}
else {
// it must be a new addition
AddAccountingLineEvent addEvent = new AddAccountingLineEvent(indexedErrorPathPrefix, this, currentLine);
events.add(addEvent);
}
}
// detect deletions
List<TemSourceAccountingLine> remainingPersistedLines = new ArrayList<TemSourceAccountingLine>();
remainingPersistedLines.addAll(persistedLineMap.values());
for (TemSourceAccountingLine persistedLine : remainingPersistedLines) {
DeleteAccountingLineEvent deleteEvent = new DeleteAccountingLineEvent(groupErrorPathPrefix, this, persistedLine, true);
events.add(deleteEvent);
}
return events;
}
public boolean maskTravelDocumentIdentifierAndOrganizationDocNumber() {
boolean vendorPaymentAllowedBeforeFinal = getParameterService().getParameterValueAsBoolean(TravelAuthorizationDocument.class, TemConstants.TravelAuthorizationParameters.VENDOR_PAYMENT_ALLOWED_BEFORE_FINAL_APPROVAL_IND);
return !vendorPaymentAllowedBeforeFinal && !(getFinancialSystemDocumentHeader().getWorkflowDocument().isProcessed() || getFinancialSystemDocumentHeader().getWorkflowDocument().isFinal());
}
/**
* @return the advance Accounting Lines that will be used in comparisons between persisted and currrent accounting lines to generate accounting line events
*/
protected List getAdvanceAccountingLinesForComparison() {
return getAdvanceAccountingLines();
}
public String getHoldRequestorPersonName() {
if(StringUtils.isNotBlank(holdRequestorprincipalId)) {
Person person = getPersonService().getPerson(holdRequestorprincipalId);
return person.getName();
}
return KFSConstants.EMPTY_STRING;
}
public void setHoldRequestorprincipalId(String holdRequestorprincipalId) {
this.holdRequestorprincipalId = holdRequestorprincipalId;
}
/**
* This method gets the Persisted advance Accounting Lines that will be used in comparisons
*
* @return
*/
protected List getPersistedAdvanceAccountingLinesForComparison() {
return SpringContext.getBean(AccountingLineService.class).getByDocumentHeaderIdAndLineType(getAdvanceAccountingLineClass(), getDocumentNumber(), TemConstants.TRAVEL_ADVANCE_ACCOUNTING_LINE_TYPE_CODE);
}
/**
* TA's will route by profile account if they are blanket travel or if the trip type does not generate an enumbrance
* @see org.kuali.kfs.module.tem.document.TravelDocumentBase#shouldRouteByProfileAccount()
*/
@Override
protected boolean shouldRouteByProfileAccount() {
return getBlanketTravel() || !getTripType().isGenerateEncumbrance() || hasOnlyPrepaidExpenses();
}
/**
* Returns the initiation date of the TA
* @see org.kuali.kfs.module.tem.document.TravelDocument#getEffectiveDateForMileageRate(org.kuali.kfs.module.tem.businessobject.ActualExpense)
*/
@Override
public Date getEffectiveDateForMileageRate(ActualExpense expense) {
if (getTripBegin() == null) {
return new java.sql.Date(getDocumentHeader().getWorkflowDocument().getDateCreated().getMillis());
}
return new java.sql.Date(getTripBegin().getTime());
}
/**
* Returns the initiation date of the TA
* @see org.kuali.kfs.module.tem.document.TravelDocument#getEffectiveDateForMileageRate(org.kuali.kfs.module.tem.businessobject.PerDiemExpense)
*/
@Override
public Date getEffectiveDateForMileageRate(PerDiemExpense expense) {
if (getTripBegin() == null) {
return new java.sql.Date(getDocumentHeader().getWorkflowDocument().getDateCreated().getMillis());
}
return new java.sql.Date(getTripBegin().getTime());
}
/**
* Returns the initiation date of the TA
* @see org.kuali.kfs.module.tem.document.TravelDocument#getEffectiveDateForPerDiem(org.kuali.kfs.module.tem.businessobject.PerDiemExpense)
*/
@Override
public Date getEffectiveDateForPerDiem(PerDiemExpense expense) {
if (getTripBegin() == null) {
return new java.sql.Date(getDocumentHeader().getWorkflowDocument().getDateCreated().getMillis());
}
return new java.sql.Date(getTripBegin().getTime());
}
/**
* Returns the initiation date of the TA
* @see org.kuali.kfs.module.tem.document.TravelDocument#getEffectiveDateForPerDiem(java.sql.Date)
*/
@Override
public Date getEffectiveDateForPerDiem(java.sql.Timestamp expenseDate) {
if (getTripBegin() == null) {
return new java.sql.Date(getDocumentHeader().getWorkflowDocument().getDateCreated().getMillis());
}
return new java.sql.Date(getTripBegin().getTime());
}
/**
* The note target for the big travel docs are the progenitor of the trip
* @see org.kuali.rice.krad.document.DocumentBase#getNoteTarget()
*/
@Override
public PersistableBusinessObject getNoteTarget() {
if (StringUtils.isBlank(getTravelDocumentIdentifier()) || isTripProgenitor()) {
// I may not even have a travel doc identifier yet, or else, I call myself the progentitor! I must be the progenitor!
return getDocumentHeader();
}
final TravelDocument rootDocument = getTravelDocumentService().getRootTravelDocumentWithoutWorkflowDocument(getTravelDocumentIdentifier());
if (rootDocument == null) {
return getDocumentHeader(); // I couldn't find a root, so once again, chances are that I am the progenitor, even though I don't believe it entirely myself
}
return rootDocument.getDocumentHeader();
}
/**
* @return all travel advances associated with the trip, save for the one associated with this document
*/
public List<TravelAdvance> getTravelAdvances() {
if (travelAdvancesForTrip == null) {
travelAdvancesForTrip = getTravelDocumentService().getTravelAdvancesForTrip(getTravelDocumentIdentifier());
}
return travelAdvancesForTrip;
}
/**
* @return the default implementation of the PersonService
*/
protected static PersonService getPersonService() {
if (personService == null) {
personService = SpringContext.getBean(PersonService.class);
}
return personService;
}
/**
* @return the default implementation of the PaymentSourceHelperService
*/
protected static PaymentSourceHelperService getPaymentSourceHelperService() {
if (paymentSourceHelperService == null) {
paymentSourceHelperService = SpringContext.getBean(PaymentSourceHelperService.class);
}
return paymentSourceHelperService;
}
/**
* @return the default implementation of the OptionsService
*/
protected static OptionsService getOptionsService() {
if (optionsService == null) {
optionsService = SpringContext.getBean(OptionsService.class);
}
return optionsService;
}
protected static UniversityDateService getUniversityDateService() {
if (universityDateService == null) {
universityDateService = SpringContext.getBean(UniversityDateService.class);
}
return universityDateService;
}
protected static OffsetDefinitionService getOffsetDefinitionService() {
if (offsetDefinitionService == null) {
offsetDefinitionService = SpringContext.getBean(OffsetDefinitionService.class);
}
return offsetDefinitionService;
}
}