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.gl.businessobject.lookup;
017
018 import java.util.Iterator;
019 import java.util.List;
020 import java.util.Map;
021
022 import org.kuali.kfs.gl.Constant;
023 import org.kuali.kfs.gl.GeneralLedgerConstants;
024 import org.kuali.kfs.gl.businessobject.AccountBalance;
025 import org.kuali.kfs.gl.businessobject.TransientBalanceInquiryAttributes;
026 import org.kuali.kfs.gl.businessobject.inquiry.AccountBalanceByObjectInquirableImpl;
027 import org.kuali.kfs.gl.businessobject.inquiry.AccountBalanceInquirableImpl;
028 import org.kuali.kfs.gl.service.AccountBalanceService;
029 import org.kuali.kfs.sys.KFSConstants;
030 import org.kuali.kfs.sys.KFSPropertyConstants;
031 import org.kuali.rice.kns.bo.BusinessObject;
032 import org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl;
033 import org.kuali.rice.kns.lookup.CollectionIncomplete;
034 import org.kuali.rice.kns.lookup.HtmlData;
035
036 /**
037 * An extension of KualiLookupableImpl to support the account balance by object inquiry screen
038 */
039 public class AccountBalanceByObjectLookupableHelperServiceImpl extends AbstractLookupableHelperServiceImpl {
040 private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(AccountBalanceByObjectLookupableHelperServiceImpl.class);
041
042 private AccountBalanceService accountBalanceService;
043
044 public void setAccountBalanceService(AccountBalanceService abs) {
045 accountBalanceService = abs;
046 }
047
048 /**
049 * Returns the inquiry url for a result field.
050 *
051 * @param bo the business object instance to build the urls for
052 * @param propertyName the property which links to an inquirable
053 * @return String url to inquiry
054 */
055 @Override
056 public HtmlData getInquiryUrl(BusinessObject bo, String propertyName) {
057 if (GeneralLedgerConstants.DummyBusinessObject.LINK_BUTTON_OPTION.equals(propertyName)) {
058 return (new AccountBalanceByObjectInquirableImpl()).getInquiryUrl(bo, propertyName);
059 }
060 return (new AccountBalanceInquirableImpl()).getInquiryUrl(bo, propertyName);
061 }
062
063 /**
064 * Uses Lookup Service to provide a basic search.
065 *
066 * @param fieldValues - Map containing prop name keys and search values
067 * @return List found business objects
068 */
069 public List getSearchResults(Map fieldValues) {
070 LOG.debug("getSearchResults() started");
071
072 setBackLocation((String) fieldValues.get(KFSConstants.BACK_LOCATION));
073 setDocFormKey((String) fieldValues.get(KFSConstants.DOC_FORM_KEY));
074
075 BusinessObjectFieldConverter.escapeSingleQuote(fieldValues);
076
077 String costShareOption = (String) fieldValues.get(GeneralLedgerConstants.DummyBusinessObject.COST_SHARE_OPTION);
078 String pendingEntryOption = (String) fieldValues.get(GeneralLedgerConstants.DummyBusinessObject.PENDING_ENTRY_OPTION);
079 String consolidationOption = (String) fieldValues.get(GeneralLedgerConstants.DummyBusinessObject.CONSOLIDATION_OPTION);
080 boolean isCostShareExcluded = Constant.COST_SHARE_EXCLUDE.equals(costShareOption);
081 int pendingEntryCode = AccountBalanceService.PENDING_NONE;
082 if (GeneralLedgerConstants.PendingEntryOptions.APPROVED.equals(pendingEntryOption)) {
083 pendingEntryCode = AccountBalanceService.PENDING_APPROVED;
084 }
085 else if (GeneralLedgerConstants.PendingEntryOptions.ALL.equals(pendingEntryOption)) {
086 pendingEntryCode = AccountBalanceService.PENDING_ALL;
087 }
088 boolean isConsolidated = Constant.CONSOLIDATION.equals(consolidationOption);
089
090 String chartOfAccountsCode = (String) fieldValues.get(KFSPropertyConstants.CHART_OF_ACCOUNTS_CODE);
091 String accountNumber = (String) fieldValues.get(KFSPropertyConstants.ACCOUNT_NUMBER);
092 String subAccountNumber = (String) fieldValues.get(KFSPropertyConstants.SUB_ACCOUNT_NUMBER);
093 String financialObjectLevelCode = (String) fieldValues.get(GeneralLedgerConstants.BalanceInquiryDrillDowns.OBJECT_LEVEL_CODE);
094 String financialReportingSortCode = (String) fieldValues.get(GeneralLedgerConstants.BalanceInquiryDrillDowns.REPORTING_SORT_CODE);
095
096 // Dashes means no sub account number
097 if (KFSConstants.getDashSubAccountNumber().equals(subAccountNumber)) {
098 subAccountNumber = "";
099 }
100
101 String ufy = (String) fieldValues.get(KFSPropertyConstants.UNIVERSITY_FISCAL_YEAR);
102
103 // TODO Deal with invalid numbers
104 Integer universityFiscalYear = new Integer(Integer.parseInt(ufy));
105
106 List results = accountBalanceService.findAccountBalanceByObject(universityFiscalYear, chartOfAccountsCode, accountNumber, subAccountNumber, financialObjectLevelCode, financialReportingSortCode, isCostShareExcluded, isConsolidated, pendingEntryCode);
107
108 // Put the search related stuff in the objects
109 for (Iterator iter = results.iterator(); iter.hasNext();) {
110 AccountBalance ab = (AccountBalance) iter.next();
111
112 TransientBalanceInquiryAttributes dbo = ab.getDummyBusinessObject();
113 dbo.setConsolidationOption(consolidationOption);
114 dbo.setCostShareOption(costShareOption);
115 dbo.setPendingEntryOption(pendingEntryOption);
116 dbo.setLinkButtonOption(Constant.LOOKUP_BUTTON_VALUE);
117 }
118 return new CollectionIncomplete(results, new Long(results.size()));
119 }
120 }