/*
* 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.gl.businessobject.inquiry;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import org.kuali.kfs.gl.Constant;
import org.kuali.kfs.gl.businessobject.Balance;
import org.kuali.kfs.sys.KFSConstants;
import org.kuali.kfs.sys.KFSPropertyConstants;
import org.kuali.kfs.sys.businessobject.SystemOptions;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.kfs.sys.service.OptionsService;
import org.kuali.rice.kns.service.BusinessObjectDictionaryService;
import org.kuali.rice.krad.service.LookupService;
/**
* This class is used to generate the URL for the user-defined attributes for available account balace screen. It is entended the
* AbstractGeneralLedgerInquirableImpl class, so it covers both the default implementation and customized implemetnation.
*/
public class AccountBalanceInquirableImpl extends AbstractGeneralLedgerInquirableImpl {
private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(AccountBalanceInquirableImpl.class);
private BusinessObjectDictionaryService dataDictionary;
private LookupService lookupService;
private Class businessObjectClass;
/**
* Builds the keys for this inquiry.
* @return a List of Strings, holding the keys of this inquiry
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#buildUserDefinedAttributeKeyList()
*/
protected List buildUserDefinedAttributeKeyList() {
List keys = new ArrayList();
keys.add(KFSPropertyConstants.UNIVERSITY_FISCAL_YEAR);
keys.add(KFSPropertyConstants.ACCOUNT_NUMBER);
keys.add(KFSPropertyConstants.CHART_OF_ACCOUNTS_CODE);
keys.add(KFSPropertyConstants.SUB_ACCOUNT_NUMBER);
keys.add(KFSPropertyConstants.OBJECT_CODE);
keys.add(KFSPropertyConstants.SUB_OBJECT_CODE);
keys.add(Constant.CONSOLIDATION_OPTION);
keys.add(Constant.PENDING_ENTRY_OPTION);
return keys;
}
/**
* The addition of user attributes - current budget, actual budget, and encumbrance balance
* @return a Map of user defined attributes
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#getUserDefinedAttributeMap()
*/
protected Map getUserDefinedAttributeMap() {
Map userDefinedAttributeMap = new HashMap();
OptionsService os = SpringContext.getBean(OptionsService.class);
SystemOptions o = os.getCurrentYearOptions();
userDefinedAttributeMap.put(KFSPropertyConstants.CURRENT_BUDGET_LINE_BALANCE_AMOUNT, Constant.BALANCE_TYPE_CB);
userDefinedAttributeMap.put(KFSPropertyConstants.ACCOUNT_LINE_ACTUALS_BALANCE_AMOUNT, o.getActualFinancialBalanceTypeCd());
userDefinedAttributeMap.put(KFSPropertyConstants.ACCOUNT_LINE_ENCUMBRANCE_BALANCE_AMOUNT, KFSConstants.AGGREGATE_ENCUMBRANCE_BALANCE_TYPE_CODE);
return userDefinedAttributeMap;
}
/**
* Changes the name of attributes on the fly...in this case, doesn't do anything
* @param attributeName the attribute to rename
* @return a String with the new attribute name
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#getAttributeName(java.lang.String)
*/
protected String getAttributeName(String attributeName) {
return attributeName;
}
/**
* If the key name sent in represents an "exclusive field", returns "" as the key value
* @param keyName the name of the key that may be changed
* @param keyValue the value of the key that may be changed
* @return an Object with the perhaps modified value for the key
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#getKeyValue(java.lang.String, java.lang.Object)
*/
protected Object getKeyValue(String keyName, Object keyValue) {
if (isExclusiveField(keyName, keyValue)) {
keyValue = "";
}
return keyValue;
}
/**
* Justs returns the key name given
* @param keyName a key name
* @return the key name given
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#getKeyName(java.lang.String)
*/
protected String getKeyName(String keyName) {
return keyName;
}
/**
* Return a Spring bean for the drill up lookup, which is the balance lookup
* @return the name of the Spring bean of the lookup
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#getLookupableImplAttributeName()
*/
protected String getLookupableImplAttributeName() {
return Constant.GL_LOOKUPABLE_BALANCE;
}
/**
* Return the page name of this lookup
* @return the page name for inquiry options
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#getBaseUrl()
*/
protected String getBaseUrl() {
return KFSConstants.GL_BALANCE_INQUIRY_ACTION;
}
/**
* Retrieves the business class to use as the basis of an inquiry for the given attribute; in this case, it's always Balance
* @param attributeName the name to build the inquiry link to
* @return the Class of the business object that should be inquired on
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#getInquiryBusinessObjectClass(String)
*/
protected Class getInquiryBusinessObjectClass(String attributeName) {
return Balance.class;
}
/**
* Addes the lookup impl and balance type attributes to the parameters
* @param parameter the parameters used in the lookup
* @param attributeName the attribute name that an inquiry URL is being built for
* @see org.kuali.kfs.gl.businessobject.inquiry.AbstractGeneralLedgerInquirableImpl#addMoreParameters(java.util.Properties, java.lang.String)
*/
protected void addMoreParameters(Properties parameter, String attributeName) {
parameter.put(KFSConstants.LOOKUPABLE_IMPL_ATTRIBUTE_NAME, getLookupableImplAttributeName());
parameter.put(Constant.AMOUNT_VIEW_OPTION, Constant.MONTHLY);
String balanceTypeCode = (String) getUserDefinedAttributeMap().get(getAttributeName(attributeName));
parameter.put(KFSPropertyConstants.BALANCE_TYPE_CODE, balanceTypeCode);
}
}