/*
* 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.purap.document.validation.impl;
import org.apache.commons.lang.StringUtils;
import org.kuali.kfs.module.purap.PurapConstants;
import org.kuali.kfs.module.purap.PurapConstants.PREQDocumentsStrings;
import org.kuali.kfs.module.purap.PurapKeyConstants;
import org.kuali.kfs.module.purap.PurapParameterConstants;
import org.kuali.kfs.module.purap.document.AccountsPayableDocument;
import org.kuali.kfs.module.purap.document.PaymentRequestDocument;
import org.kuali.kfs.module.purap.document.PurchasingAccountsPayableDocument;
import org.kuali.kfs.module.purap.document.service.PaymentRequestService;
import org.kuali.kfs.module.purap.document.service.PurapService;
import org.kuali.kfs.module.purap.document.validation.event.AttributedExpiredAccountWarningEvent;
import org.kuali.kfs.module.purap.document.validation.event.AttributedTradeInWarningEvent;
import org.kuali.kfs.sys.KFSConstants;
import org.kuali.kfs.sys.KFSKeyConstants;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.kfs.sys.service.UniversityDateService;
import org.kuali.kfs.sys.service.impl.KfsParameterConstants;
import org.kuali.rice.core.api.config.property.ConfigurationService;
import org.kuali.rice.core.web.format.CurrencyFormatter;
import org.kuali.rice.coreservice.framework.parameter.ParameterService;
import org.kuali.rice.krad.document.Document;
import org.kuali.rice.krad.service.KualiRuleService;
/**
* Business pre rule(s) applicable to Payment Request documents.
*/
public class PaymentRequestDocumentPreRules extends AccountsPayableDocumentPreRulesBase {
/**
* Default Constructor
*/
public PaymentRequestDocumentPreRules() {
super();
}
/**
* Main hook point to perform rules check.
*
* @see org.kuali.rice.kns.rules.PromptBeforeValidationBase#doRules(org.kuali.rice.krad.document.Document)
*/
@Override
public boolean doPrompts(Document document) {
boolean preRulesOK = true;
PaymentRequestDocument preq = (PaymentRequestDocument) document;
if ((!SpringContext.getBean(PurapService.class).isFullDocumentEntryCompleted(preq)) || (StringUtils.equals(preq.getApplicationDocumentStatus(), PurapConstants.PaymentRequestStatuses.APPDOC_AWAITING_ACCOUNTS_PAYABLE_REVIEW))) {
if (!confirmPayDayNotOverThresholdDaysAway(preq)) {
return false;
}
if (!confirmUnusedTradeIn(preq)) {
return false;
}
if (!confirmEncumberNextFiscalYear(preq)) {
return false;
}
if (!confirmEncumberPriorFiscalYear(preq)) {
return false;
}
}
if (SpringContext.getBean(PurapService.class).isFullDocumentEntryCompleted(preq)) {
if (!confirmExpiredAccount(preq)) {
return false;
}
}
preRulesOK &= super.doPrompts(document);
return preRulesOK;
}
/**
* Prompts user to confirm with a Yes or No to a question being asked.
*
* @param questionType - type of question
* @param messageConstant - key to retrieve message
* @return - true if overriding, false otherwise
*/
protected boolean askForConfirmation(String questionType, String messageConstant) {
String questionText = SpringContext.getBean(ConfigurationService.class).getPropertyValueAsString(messageConstant);
if (questionText.contains("{")) {
questionText = prepareQuestionText(questionType, questionText);
}
else if (StringUtils.equals(messageConstant, KFSKeyConstants.ERROR_ACCOUNT_EXPIRED) || StringUtils.equals(messageConstant,PurapKeyConstants.WARNING_ITEM_TRADE_IN_AMOUNT_UNUSED)) {
questionText = questionType;
}
boolean confirmOverride = super.askOrAnalyzeYesNoQuestion(questionType, questionText);
if (!confirmOverride) {
event.setActionForwardName(KFSConstants.MAPPING_BASIC);
return false;
}
return true;
}
/**
* Creates the actual text of the question, replacing place holders like pay date threshold with an actual constant value.
*
* @param questionType - type of question
* @param questionText - actual text of question pulled from resource file
* @return - question text with place holders replaced
*/
protected String prepareQuestionText(String questionType, String questionText) {
if (StringUtils.equals(questionType, PREQDocumentsStrings.THRESHOLD_DAYS_OVERRIDE_QUESTION)) {
questionText = StringUtils.replace(questionText, "{0}", new Integer(PurapConstants.PREQ_PAY_DATE_DAYS_BEFORE_WARNING).toString());
}
return questionText;
}
/**
* Validates if the pay date threshold has not been passed, if so confirmation is required by the user to
* exceed the threshold.
*
* @param preq - payment request document
* @return - true if threshold has not been surpassed or if user confirmed ok to override, false otherwise
*/
public boolean confirmPayDayNotOverThresholdDaysAway(PaymentRequestDocument preq) {
// If the pay date is more than the threshold number of days in the future, ask for confirmation.
//boolean rulePassed = SpringContext.getBean(KualiRuleService.class).applyRules(new AttributedPayDateNotOverThresholdDaysAwayEvent("", preq));
//if (!rulePassed) {
// The problem is that rulePassed always return true
int thresholdDays = PurapConstants.PREQ_PAY_DATE_DAYS_BEFORE_WARNING;
if ((preq.getPaymentRequestPayDate() != null) && SpringContext.getBean(PurapService.class).isDateMoreThanANumberOfDaysAway(preq.getPaymentRequestPayDate(), thresholdDays)) {
return askForConfirmation(PREQDocumentsStrings.THRESHOLD_DAYS_OVERRIDE_QUESTION, PurapKeyConstants.MESSAGE_PAYMENT_REQUEST_PAYDATE_OVER_THRESHOLD_DAYS);
}
return true;
}
public boolean confirmUnusedTradeIn(PaymentRequestDocument preq) {
boolean rulePassed = SpringContext.getBean(KualiRuleService.class).applyRules(new AttributedTradeInWarningEvent("", preq));
if (!rulePassed) {
return askForConfirmation(PREQDocumentsStrings.UNUSED_TRADE_IN_QUESTION, PurapKeyConstants.WARNING_ITEM_TRADE_IN_AMOUNT_UNUSED);
}
return true;
}
public boolean confirmExpiredAccount(PaymentRequestDocument preq) {
boolean rulePassed = SpringContext.getBean(KualiRuleService.class).applyRules(new AttributedExpiredAccountWarningEvent("", preq));
if (!rulePassed) {
return askForConfirmation(PREQDocumentsStrings.EXPIRED_ACCOUNT_QUESTION, KFSKeyConstants.ERROR_ACCOUNT_EXPIRED);
}
return true;
}
public boolean confirmEncumberNextFiscalYear(PaymentRequestDocument preq) {
Integer fiscalYear = SpringContext.getBean(UniversityDateService.class).getCurrentFiscalYear();
if (preq.getPurchaseOrderDocument().getPostingYear().intValue() > fiscalYear) {
return askForConfirmation(PREQDocumentsStrings.ENCUMBER_NEXT_FISCAL_YEAR_QUESTION, PurapKeyConstants.WARNING_ENCUMBER_NEXT_FY);
}
return true;
}
public boolean confirmEncumberPriorFiscalYear(PaymentRequestDocument preq) {
Integer fiscalYear = SpringContext.getBean(UniversityDateService.class).getCurrentFiscalYear();
if (preq.getPurchaseOrderDocument().getPostingYear().intValue() == fiscalYear && SpringContext.getBean(PaymentRequestService.class).allowBackpost(preq)) {
return askForConfirmation(PREQDocumentsStrings.ENCUMBER_PRIOR_FISCAL_YEAR_QUESTION, PurapKeyConstants.WARNING_ENCUMBER_PRIOR_FY);
}
return true;
}
/**
* @see org.kuali.kfs.module.purap.document.validation.impl.AccountsPayableDocumentPreRulesBase#getDocumentName()
*/
@Override
public String getDocumentName() {
return "Payment Request";
}
/**
* @see org.kuali.kfs.module.purap.document.validation.impl.AccountsPayableDocumentPreRulesBase#createInvoiceNoMatchQuestionText(org.kuali.kfs.module.purap.document.AccountsPayableDocument)
*/
@Override
public String createInvoiceNoMatchQuestionText(AccountsPayableDocument accountsPayableDocument){
String questionText = super.createInvoiceNoMatchQuestionText(accountsPayableDocument);
CurrencyFormatter cf = new CurrencyFormatter();
PaymentRequestDocument preq = (PaymentRequestDocument) accountsPayableDocument;
StringBuffer questionTextBuffer = new StringBuffer("");
questionTextBuffer.append(questionText);
questionTextBuffer.append("[br][br][b]Summary Detail Below:[b][br][br][table questionTable]");
questionTextBuffer.append("[tr][td leftTd]Vendor Invoice Amount entered on start screen:[/td][td rightTd]" + (String)cf.format(preq.getInitialAmount()) + "[/td][/tr]");
questionTextBuffer.append("[tr][td leftTd]Invoice Total Prior to Additional Charges:[/td][td rightTd]" + (String)cf.format(preq.getTotalPreTaxDollarAmountAboveLineItems()) + "[/td][/tr]");
//only add this line if payment request has a discount
if( preq.isDiscount() ){
questionTextBuffer.append("[tr][td leftTd]Total Before Discount:[/td][td rightTd]" + (String)cf.format(preq.getGrandPreTaxTotalExcludingDiscount()) + "[/td][/tr]");
}
//if sales tax is enabled, show additional summary lines
boolean salesTaxInd = SpringContext.getBean(ParameterService.class).getParameterValueAsBoolean(KfsParameterConstants.PURCHASING_DOCUMENT.class, PurapParameterConstants.ENABLE_SALES_TAX_IND);
if(salesTaxInd){
questionTextBuffer.append("[tr][td leftTd]Grand Total Prior to Tax:[/td][td rightTd]" + (String)cf.format(preq.getGrandPreTaxTotal()) + "[/td][/tr]");
questionTextBuffer.append("[tr][td leftTd]Grand Total Tax:[/td][td rightTd]" + (String)cf.format(preq.getGrandTaxAmount()) + "[/td][/tr]");
}
questionTextBuffer.append("[tr][td leftTd]Grand Total:[/td][td rightTd]" + (String)cf.format(preq.getGrandTotal()) + "[/td][/tr][/table]");
return questionTextBuffer.toString();
}
@Override
protected boolean checkCAMSWarningStatus(PurchasingAccountsPayableDocument purapDocument) {
return PurapConstants.CAMSWarningStatuses.PAYMENT_REQUEST_STATUS_WARNING_NO_CAMS_DATA.contains(purapDocument.getApplicationDocumentStatus());
}
/**
* Determines if the amount entered on the init tab is mismatched with the grand total of the document.
*
* @param accountsPayableDocument
* @return
*/
@Override
protected boolean validateInvoiceTotalsAreMismatched(AccountsPayableDocument accountsPayableDocument) {
boolean mismatched = false;
PaymentRequestDocument payReqDoc = (PaymentRequestDocument) accountsPayableDocument;
String[] excludeArray = { PurapConstants.ItemTypeCodes.ITEM_TYPE_PMT_TERMS_DISCOUNT_CODE };
// if UseTax is included, then the invoiceInitialAmount should be compared against the
// total amount NOT INCLUDING tax
if (payReqDoc.isUseTaxIndicator()) {
if (payReqDoc.getTotalPreTaxDollarAmountAllItems(excludeArray).compareTo(accountsPayableDocument.getInitialAmount()) != 0 && !accountsPayableDocument.isUnmatchedOverride()) {
mismatched = true;
}
}
// if NO UseTax, then the invoiceInitialAmount should be compared against the
// total amount INCLUDING sales tax (since if the vendor invoices with sales tax, then we pay it)
else {
if (accountsPayableDocument.getTotalDollarAmountAllItems(excludeArray).compareTo(accountsPayableDocument.getInitialAmount()) != 0 && !accountsPayableDocument.isUnmatchedOverride()) {
mismatched = true;
}
}
return mismatched;
}
}