001/*
002     * Copyright 2006 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 */
016package org.kuali.ole.gl.businessobject.lookup;
017
018import java.util.Iterator;
019import java.util.List;
020import java.util.Map;
021
022import org.kuali.ole.gl.Constant;
023import org.kuali.ole.gl.GeneralLedgerConstants;
024import org.kuali.ole.gl.businessobject.AccountBalance;
025import org.kuali.ole.gl.businessobject.TransientBalanceInquiryAttributes;
026import org.kuali.ole.gl.businessobject.inquiry.AccountBalanceByConsolidationInquirableImpl;
027import org.kuali.ole.gl.service.AccountBalanceService;
028import org.kuali.ole.sys.OLEConstants;
029import org.kuali.ole.sys.OLEPropertyConstants;
030import org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl;
031import org.kuali.rice.kns.lookup.HtmlData;
032import org.kuali.rice.krad.bo.BusinessObject;
033import org.kuali.rice.krad.lookup.CollectionIncomplete;
034
035/**
036 * An extension of KualiLookupableImpl to support the account balance by consolidation inquiry screen
037 */
038public 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(OLEConstants.BACK_LOCATION));
072        setDocFormKey((String) fieldValues.get(OLEConstants.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        // KFSMI-410: need to get this before getting isConsolidated because this value will be removed.
079        String consolidationOption = (String) fieldValues.get(GeneralLedgerConstants.DummyBusinessObject.CONSOLIDATION_OPTION);
080        String chartOfAccountsCode = (String) fieldValues.get(OLEPropertyConstants.CHART_OF_ACCOUNTS_CODE);
081        String accountNumber = (String) fieldValues.get(OLEPropertyConstants.ACCOUNT_NUMBER);
082        String subAccountNumber = (String) fieldValues.get(OLEPropertyConstants.SUB_ACCOUNT_NUMBER);
083        String ufy = (String) fieldValues.get(OLEPropertyConstants.UNIVERSITY_FISCAL_YEAR);
084        
085        boolean isCostShareExcluded = Constant.COST_SHARE_EXCLUDE.equals(costShareOption);
086
087        int pendingEntryCode = AccountBalanceService.PENDING_NONE;
088        if (GeneralLedgerConstants.PendingEntryOptions.APPROVED.equals(pendingEntryOption)) {
089            pendingEntryCode = AccountBalanceService.PENDING_APPROVED;
090        }
091        else if (GeneralLedgerConstants.PendingEntryOptions.ALL.equals(pendingEntryOption)) {
092            pendingEntryCode = AccountBalanceService.PENDING_ALL;
093        }
094        boolean isConsolidated = Constant.CONSOLIDATION.equals(consolidationOption);
095        
096        // KFSMI-410: added one more node for consolidationOption
097        if (consolidationOption.equals(Constant.EXCLUDE_SUBACCOUNTS)){
098            subAccountNumber = OLEConstants.getDashSubAccountNumber();
099            isConsolidated = false;
100        } 
101
102        // TODO Deal with invalid numbers
103        Integer universityFiscalYear = new Integer(Integer.parseInt(ufy));
104
105        List results = accountBalanceService.findAccountBalanceByConsolidation(universityFiscalYear, chartOfAccountsCode, accountNumber, subAccountNumber, isCostShareExcluded, isConsolidated, pendingEntryCode);
106
107        // Put the search related stuff in the objects
108        int count = 0;
109        for (Iterator iter = results.iterator(); iter.hasNext();) {
110            AccountBalance ab = (AccountBalance) iter.next();
111            count++;
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            // Set the variance on the detail lines
119            if (count > 7) {
120                dbo.setGenericAmount(ab.getVariance());
121            }
122        }
123        return new CollectionIncomplete(results, new Long(results.size()));
124    }
125}