001 /*
002 * Copyright 2011 The Kuali Foundation.
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.kuali.kfs.module.purap.service.impl;
017
018 import org.kuali.kfs.coa.businessobject.Account;
019 import org.kuali.kfs.coa.businessobject.ObjectCode;
020 import org.kuali.kfs.coa.businessobject.SubObjectCode;
021 import org.kuali.kfs.coa.service.AccountService;
022 import org.kuali.kfs.coa.service.ObjectCodeService;
023 import org.kuali.kfs.coa.service.SubObjectCodeService;
024 import org.kuali.kfs.gl.batch.ScrubberStep;
025 import org.kuali.kfs.module.purap.PurapKeyConstants;
026 import org.kuali.kfs.module.purap.PurapConstants.PaymentRequestStatuses;
027 import org.kuali.kfs.module.purap.document.PaymentRequestDocument;
028 import org.kuali.kfs.module.purap.document.service.PaymentRequestService;
029 import org.kuali.kfs.sys.KFSConstants;
030 import org.kuali.kfs.sys.KFSKeyConstants;
031 import org.kuali.kfs.sys.businessobject.AccountingLine;
032 import org.kuali.kfs.sys.context.SpringContext;
033 import org.kuali.rice.kns.datadictionary.DataDictionary;
034 import org.kuali.rice.kns.service.DateTimeService;
035 import org.kuali.rice.kns.service.ParameterService;
036 import org.kuali.rice.kns.util.GlobalVariables;
037 import org.kuali.rice.kns.util.ObjectUtils;
038
039 public class PaymentRequestAccountingLineRuleHelperServiceImpl extends PurapAccountingLineRuleHelperServiceImpl {
040
041 /**
042 * @see org.kuali.kfs.module.purap.service.impl.AccountsPayableAccountingLineRuleHelperServiceImpl#hasRequiredOverrides(org.kuali.kfs.sys.businessobject.AccountingLine, java.lang.String)
043 * For payment request we must throw an error after AP approval for C&G accounts that are expired more than 90 days.
044 */
045 @Override
046 public boolean hasRequiredOverrides(AccountingLine line, String overrideCode) {
047 boolean hasOverrides = true;
048
049 Account account = SpringContext.getBean(AccountService.class).getByPrimaryId(line.getChartOfAccountsCode(), line.getAccountNumber());
050 String docStatus = getDocument().getStatusCode();
051
052 //if account exists
053 if(ObjectUtils.isNotNull(account)){
054 //after AP approval
055 if(PaymentRequestStatuses.AWAITING_SUB_ACCT_MGR_REVIEW.equals(docStatus) ||
056 PaymentRequestStatuses.AWAITING_FISCAL_REVIEW.equals(docStatus) ||
057 PaymentRequestStatuses.AWAITING_ORG_REVIEW.equals(docStatus) ||
058 PaymentRequestStatuses.AWAITING_TAX_REVIEW.equals(docStatus) ||
059 PaymentRequestStatuses.DEPARTMENT_APPROVED.equals(docStatus) ||
060 PaymentRequestStatuses.AUTO_APPROVED.equals(docStatus) ){
061
062 String expirationExtensionDays = SpringContext.getBean(ParameterService.class).getParameterValue(ScrubberStep.class, KFSConstants.SystemGroupParameterNames.GL_SCRUBBER_VALIDATION_DAYS_OFFSET);
063 int expirationExtensionDaysInt = 3 * 30; // default to 90 days (approximately 3 months)
064
065 if (ObjectUtils.isNotNull(expirationExtensionDays) && expirationExtensionDays.trim().length() > 0) {
066
067 expirationExtensionDaysInt = new Integer(expirationExtensionDays).intValue();
068 }
069
070 //if account is expired, c&g and past 90 days, add error
071 if(account.isExpired() && account.isForContractsAndGrants() && (SpringContext.getBean(DateTimeService.class).dateDiff(account.getAccountExpirationDate(), SpringContext.getBean(DateTimeService.class).getCurrentDate(), true) > expirationExtensionDaysInt)){
072 GlobalVariables.getMessageMap().putError(KFSConstants.ACCOUNT_NUMBER_PROPERTY_NAME, PurapKeyConstants.ERROR_ITEM_ACCOUNT_EXPIRED_REPLACE, account.getAccountNumber());
073 hasOverrides = false;
074 }
075 }
076 }else{
077 //account not valid, shouldn't happen but just in case
078 hasOverrides = false;
079 }
080 return hasOverrides;
081 }
082
083
084 public boolean isValidObjectCode(ObjectCode objectCode, DataDictionary dataDictionary, String errorPropertyName) {
085 String label = getObjectCodeLabel();
086
087 // make sure it exists
088 if (ObjectUtils.isNull(objectCode)) {
089 GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_EXISTENCE, label);
090 return false;
091 }
092
093 Integer universityFiscalYear = ((PaymentRequestDocument)getDocument()).getPostingYearPriorOrCurrent();
094 ObjectCode objectCodeForValidation = (SpringContext.getBean(ObjectCodeService.class).getByPrimaryId(universityFiscalYear, objectCode.getChartOfAccountsCode(), objectCode.getFinancialObjectCode()));
095
096 // check active status
097 if (!objectCodeForValidation.isFinancialObjectActiveCode()) {
098 GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_INACTIVE, label);
099 return false;
100 }
101
102 return true;
103 }
104
105
106
107 public boolean isValidSubObjectCode(SubObjectCode subObjectCode, DataDictionary dataDictionary, String errorPropertyName) {
108 String label = getSubObjectCodeLabel();
109
110 // make sure it exists
111 if (ObjectUtils.isNull(subObjectCode)) {
112 GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_EXISTENCE, label);
113 return false;
114 }
115
116 Integer universityFiscalYear = ((PaymentRequestDocument)getDocument()).getPostingYearPriorOrCurrent();
117 SubObjectCode subObjectCodeForValidation = (SpringContext.getBean(SubObjectCodeService.class).getByPrimaryId(universityFiscalYear, subObjectCode.getChartOfAccountsCode(), subObjectCode.getAccountNumber(), subObjectCode.getFinancialObjectCode(), subObjectCode.getFinancialSubObjectCode()));
118
119
120 // check active flag
121 if (!subObjectCodeForValidation.isActive()) {
122 GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_INACTIVE, label);
123 return false;
124 }
125
126 return true;
127 }
128
129 }