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.AccountBalanceByConsolidationInquirableImpl;
027    import org.kuali.kfs.gl.service.AccountBalanceService;
028    import org.kuali.kfs.sys.KFSConstants;
029    import org.kuali.kfs.sys.KFSPropertyConstants;
030    import org.kuali.rice.kns.bo.BusinessObject;
031    import org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl;
032    import org.kuali.rice.kns.lookup.CollectionIncomplete;
033    import org.kuali.rice.kns.lookup.HtmlData;
034    
035    /**
036     * An extension of KualiLookupableImpl to support the account balance by consolidation inquiry screen
037     */
038    public class AccountBalanceByConsolidationLookupableHelperServiceImpl extends AbstractLookupableHelperServiceImpl {
039    
040        private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(AccountBalanceByConsolidationLookupableHelperServiceImpl.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            HtmlData hRef = (new AccountBalanceByConsolidationInquirableImpl()).getInquiryUrl(bo, propertyName);
058            return hRef;
059        }
060    
061        /**
062         * Get the search results that meet the input search criteria.
063         * 
064         * @param fieldValues - Map containing prop name keys and search values
065         * @return a List of found business objects
066         */
067        @Override
068        public List<? extends BusinessObject> getSearchResults(Map<String, String> fieldValues) {
069            LOG.debug("getSearchResults() started");
070    
071            setBackLocation((String) fieldValues.get(KFSConstants.BACK_LOCATION));
072            setDocFormKey((String) fieldValues.get(KFSConstants.DOC_FORM_KEY));
073    
074            BusinessObjectFieldConverter.escapeSingleQuote(fieldValues);
075    
076            String costShareOption = (String) fieldValues.get(GeneralLedgerConstants.DummyBusinessObject.COST_SHARE_OPTION);
077            String pendingEntryOption = (String) fieldValues.get(GeneralLedgerConstants.DummyBusinessObject.PENDING_ENTRY_OPTION);
078            String consolidationOption = (String) fieldValues.get(GeneralLedgerConstants.DummyBusinessObject.CONSOLIDATION_OPTION);
079            boolean isCostShareExcluded = Constant.COST_SHARE_EXCLUDE.equals(costShareOption);
080    
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    
089            boolean isConsolidated = Constant.CONSOLIDATION.equals(consolidationOption);
090    
091            String chartOfAccountsCode = (String) fieldValues.get(KFSPropertyConstants.CHART_OF_ACCOUNTS_CODE);
092            String accountNumber = (String) fieldValues.get(KFSPropertyConstants.ACCOUNT_NUMBER);
093            String subAccountNumber = (String) fieldValues.get(KFSPropertyConstants.SUB_ACCOUNT_NUMBER);
094            String ufy = (String) fieldValues.get(KFSPropertyConstants.UNIVERSITY_FISCAL_YEAR);
095    
096            // Dashes means no sub account number
097            if (KFSConstants.getDashSubAccountNumber().equals(subAccountNumber)) {
098                subAccountNumber = "";
099            }
100    
101            // TODO Deal with invalid numbers
102            Integer universityFiscalYear = new Integer(Integer.parseInt(ufy));
103    
104            List results = accountBalanceService.findAccountBalanceByConsolidation(universityFiscalYear, chartOfAccountsCode, accountNumber, subAccountNumber, isCostShareExcluded, isConsolidated, pendingEntryCode);
105    
106            // Put the search related stuff in the objects
107            int count = 0;
108            for (Iterator iter = results.iterator(); iter.hasNext();) {
109                AccountBalance ab = (AccountBalance) iter.next();
110                count++;
111                TransientBalanceInquiryAttributes dbo = ab.getDummyBusinessObject();
112                dbo.setConsolidationOption(consolidationOption);
113                dbo.setCostShareOption(costShareOption);
114                dbo.setPendingEntryOption(pendingEntryOption);
115                dbo.setLinkButtonOption(Constant.LOOKUP_BUTTON_VALUE);
116    
117                // Set the variance on the detail lines
118                if (count > 7) {
119                    dbo.setGenericAmount(ab.getVariance());
120                }
121            }
122            return new CollectionIncomplete(results, new Long(results.size()));
123        }
124    }