/*
* 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.sys.document.service.impl;
import java.sql.Date;
import java.text.MessageFormat;
import java.util.List;
import org.kuali.kfs.coa.businessobject.AccountingPeriod;
import org.kuali.kfs.coa.businessobject.BalanceType;
import org.kuali.kfs.coa.businessobject.ObjectCode;
import org.kuali.kfs.coa.service.ObjectCodeService;
import org.kuali.kfs.coa.service.ObjectTypeService;
import org.kuali.kfs.sys.KFSKeyConstants;
import org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.kfs.sys.document.service.AccountingDocumentRuleHelperService;
import org.kuali.rice.core.api.config.property.ConfigurationService;
import org.kuali.rice.core.api.datetime.DateTimeService;
import org.kuali.rice.kns.service.DataDictionaryService;
import org.kuali.rice.krad.datadictionary.AttributeDefinition;
import org.kuali.rice.krad.datadictionary.DataDictionaryEntry;
import org.kuali.rice.krad.util.GlobalVariables;
import org.kuali.rice.krad.util.ObjectUtils;
/**
* The default implementation of the AccountingDocumentRuleHelperService
*/
public class AccountingDocumentRuleHelperServiceImpl implements AccountingDocumentRuleHelperService {
private DataDictionaryService ddService;
private ObjectTypeService objectTypeService;
/**
* @see org.kuali.kfs.sys.document.service.AccountingDocumentRuleHelperService#isExpense(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)
*/
public boolean isExpense(GeneralLedgerPendingEntrySourceDetail postable) {
// return SpringContext.getBean(ConfigurationService.class).succeedsRule(KFSConstants.FINANCIAL_NAMESPACE,
// KUALI_TRANSACTION_PROCESSING_GLOBAL_RULES_SECURITY_GROUPING, APPLICATION_PARAMETER.EXPENSE_OBJECT_TYPE_CODES,
// getObjectCodeTypeCodeWithoutSideEffects(accountingLine) );
List<String> expenseObjectTypes = objectTypeService.getCurrentYearBasicExpenseObjectTypes();
return expenseObjectTypes.contains(getObjectCodeTypeCodeWithoutSideEffects(postable));
}
/**
* @see org.kuali.kfs.sys.document.service.AccountingDocumentRuleHelperService#isIncome(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)
*/
public boolean isIncome(GeneralLedgerPendingEntrySourceDetail postable) {
List<String> incomeObjectTypes = objectTypeService.getCurrentYearBasicIncomeObjectTypes();
return incomeObjectTypes.contains(getObjectCodeTypeCodeWithoutSideEffects(postable));
}
/**
* Makes sure that the objectCode attribute is fully populated b/c we are using proxying in our persistence layer.
*
* @param accountingLine
* @return the object type code of the object code of the given accounting line
*/
public String getObjectCodeTypeCodeWithoutSideEffects(GeneralLedgerPendingEntrySourceDetail postable) {
Integer fiscalYear = postable.getPostingYear();
String chartOfAccountsCode = postable.getChartOfAccountsCode();
String financialObjectCode = postable.getFinancialObjectCode();
ObjectCodeService objectCodeService = SpringContext.getBean(ObjectCodeService.class);
ObjectCode objectCode = objectCodeService.getByPrimaryIdWithCaching(fiscalYear, chartOfAccountsCode, financialObjectCode);
return ObjectUtils.isNotNull(objectCode) ? objectCode.getFinancialObjectTypeCode() : null;
}
/**
* @see org.kuali.kfs.sys.document.service.AccountingDocumentRuleHelperService#isValidBalanceType(org.kuali.kfs.coa.businessobject.BalanceTyp,
* java.lang.String)
*/
public boolean isValidBalanceType(BalanceType balanceType, String errorPropertyName) {
return isValidBalanceType(balanceType, BalanceType.class, errorPropertyName, errorPropertyName);
}
/**
* Looks up a label from the data dictionary
*
* @param entryClass the class of the attribute to lookup the label for
* @param attributeName the attribute to look up the label for
* @return the label
*/
protected String getLabelFromDataDictionary(Class entryClass, String attributeName) {
DataDictionaryEntry entry = ddService.getDataDictionary().getDictionaryObjectEntry(entryClass.getName());
if (entry == null) {
throw new IllegalArgumentException("Cannot find DataDictionary entry for " + entryClass);
}
AttributeDefinition attributeDefinition = entry.getAttributeDefinition(attributeName);
if (attributeDefinition == null) {
throw new IllegalArgumentException("Cannot find " + entryClass + " attribute with name " + attributeName);
}
return attributeDefinition.getLabel();
}
/**
* @see org.kuali.kfs.sys.document.service.AccountingDocumentRuleHelperService#isValidBalanceType(org.kuali.kfs.coa.businessobject.BalanceTyp,
* java.lang.Class, java.lang.String, java.lang.String)
*/
public boolean isValidBalanceType(BalanceType balanceType, Class entryClass, String attributeName, String errorPropertyName) {
String label = getLabelFromDataDictionary(entryClass, attributeName);
if (ObjectUtils.isNull(balanceType)) {
GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_EXISTENCE, label);
return false;
}
// make sure it's active for usage
if (!balanceType.isActive()) {
GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_INACTIVE, label);
return false;
}
return true;
}
/**
* @see org.kuali.kfs.sys.document.service.AccountingDocumentRuleHelperService#isValidOpenAccountingPeriod(org.kuali.kfs.coa.businessobject.AccountingPeriod,
* java.lang.Class, java.lang.String, java.lang.String)
*/
public boolean isValidOpenAccountingPeriod(AccountingPeriod accountingPeriod, Class entryClass, String attribueName, String errorPropertyName) {
// retrieve from system to make sure it exists
String label = getLabelFromDataDictionary(entryClass, attribueName);
if (ObjectUtils.isNull(accountingPeriod)) {
GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_EXISTENCE, label);
return false;
}
// make sure it's open for use
if (!accountingPeriod.isActive()) {
GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_DOCUMENT_ACCOUNTING_PERIOD_CLOSED);
return false;
}
return true;
}
/**
* @see org.kuali.kfs.sys.document.service.AccountingDocumentRuleHelperService#isValidReversalDate(java.sql.Date,
* java.lang.String)
*/
public boolean isValidReversalDate(Date reversalDate, String errorPropertyName) {
java.sql.Date today = SpringContext.getBean(DateTimeService.class).getCurrentSqlDateMidnight();
if (null != reversalDate && reversalDate.before(today)) {
GlobalVariables.getMessageMap().putError(errorPropertyName, KFSKeyConstants.ERROR_DOCUMENT_INCORRECT_REVERSAL_DATE);
return false;
}
else {
return true;
}
}
/**
* Gets the named property from ConfigurationService (i.e., from ApplicationResources.properties) and formats it with the
* given arguments (if any).
*
* @param propertyName
* @param arguments
* @return the formatted property (i.e., message), with any {@code {0}} replaced with the first argument, {@code {1}} with the
* second argument, etc.
*/
public String formatProperty(String propertyName, Object... arguments) {
return MessageFormat.format(SpringContext.getBean(ConfigurationService.class).getPropertyValueAsString(propertyName), arguments);
}
/**
* Sets the dataDictionaryService attribute value.
*
* @param ddService The ddService to set.
*/
public void setDataDictionaryService(DataDictionaryService ddService) {
this.ddService = ddService;
}
/**
* Sets the objectTypeService attribute value.
*
* @param objectTypeService The objectTypeService to set.
*/
public void setObjectTypeService(ObjectTypeService objectTypeService) {
this.objectTypeService = objectTypeService;
}
}