/*
 * Copyright 2006 The Kuali Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.opensource.org/licenses/ecl2.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kuali.ole.fp.document.web.struts;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.kuali.ole.fp.businessobject.CapitalAccountingLines;
import org.kuali.ole.fp.businessobject.CapitalAssetAccountsGroupDetails;
import org.kuali.ole.fp.businessobject.CapitalAssetInformation;
import org.kuali.ole.fp.businessobject.CapitalAssetInformationDetail;
import org.kuali.ole.fp.businessobject.options.CapitalAccountingLinesComparator;
import org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase;
import org.kuali.ole.fp.document.validation.event.CapitalAccountingLinesSameObjectCodeSubTypeEvent;
import org.kuali.ole.integration.cab.CapitalAssetBuilderModuleService;
import org.kuali.ole.sys.OLEConstants;
import org.kuali.ole.sys.OLEKeyConstants;
import org.kuali.ole.sys.businessobject.AccountingLine;
import org.kuali.ole.sys.businessobject.SourceAccountingLine;
import org.kuali.ole.sys.businessobject.TargetAccountingLine;
import org.kuali.ole.sys.context.SpringContext;
import org.kuali.ole.sys.document.AccountingDocument;
import org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase;
import org.kuali.rice.core.api.config.property.ConfigurationService;
import org.kuali.rice.core.api.util.RiceConstants;
import org.kuali.rice.kew.api.exception.WorkflowException;
import org.kuali.rice.kns.question.ConfirmationQuestion;
import org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase;
import org.kuali.rice.kns.web.struts.form.KualiForm;
import org.kuali.rice.krad.document.Document;
import org.kuali.rice.krad.service.KualiRuleService;
import org.kuali.rice.krad.util.GlobalVariables;
import org.kuali.rice.krad.util.ObjectUtils;

/**
 * This is the action class for the CapitalAccountingLinesActionBase.
 */
public abstract class CapitalAccountingLinesActionBase extends CapitalAssetInformationActionBase {
    private CapitalAssetBuilderModuleService capitalAssetBuilderModuleService = SpringContext.getBean(CapitalAssetBuilderModuleService.class);

    /**
     * removes capitalaccountinglines which is a transient bo.. and call the super method to
     * create a error correction document.
     * @see org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase#correct(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
     */
    @Override
    public ActionForward correct(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
        CapitalAccountingLinesFormBase capitalAccountingLinesFormBase = (CapitalAccountingLinesFormBase) form;
        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) capitalAccountingLinesFormBase.getFinancialDocument();
        caldb.getCapitalAccountingLines().clear();

        super.correct(mapping, capitalAccountingLinesFormBase, request, response);

        KualiAccountingDocumentFormBase kadfb = (KualiAccountingDocumentFormBase) form;
        List<CapitalAssetInformation> currentCapitalAssetInformation =  this.getCurrentCapitalAssetInformationObject(kadfb);
        for (CapitalAssetInformation capitalAsset : currentCapitalAssetInformation) {
            capitalAsset.setCapitalAssetProcessedIndicator(false);
            capitalAsset.setCapitalAssetLineAmount(capitalAsset.getCapitalAssetLineAmount().negated());
            //remove capital asset tag/location asset tag number and serial number as
            //they will fail because these values will be duplicates.
            List<CapitalAssetInformationDetail> tagLocationDetails = capitalAsset.getCapitalAssetInformationDetails();
            for (CapitalAssetInformationDetail tagLocationDetail : tagLocationDetails) {
                tagLocationDetail.setCapitalAssetTagNumber(null);
                tagLocationDetail.setCapitalAssetSerialNumber(null);
            }

            List<CapitalAssetAccountsGroupDetails> groupAccountLines = capitalAsset.getCapitalAssetAccountsGroupDetails();
            for (CapitalAssetAccountsGroupDetails groupAccountLine : groupAccountLines) {
                groupAccountLine.setAmount(groupAccountLine.getAmount().negated());
            }
        }

        String distributionAmountCode = capitalAccountingLinesFormBase.getCapitalAccountingLine().getDistributionCode();

        AccountingDocument tdoc = (AccountingDocument) capitalAccountingLinesFormBase.getDocument();

        List<CapitalAccountingLines> capitalAccountingLines = new ArrayList();
        //for every source/target accounting line that has an object code that requires a
        //capital asset, creates a capital accounting line that the user can select to
        //perform create or modify asset functions.
        createCapitalAccountingLines(capitalAccountingLines, tdoc, distributionAmountCode);
        sortCaptitalAccountingLines(capitalAccountingLines);

        caldb.setCapitalAccountingLines(capitalAccountingLines);
        //checks capital accounting lines for capital assets and if so checks the select box
        checkSelectForCapitalAccountingLines(capitalAccountingLinesFormBase);

        checkCapitalAccountingLinesSelected(capitalAccountingLinesFormBase);
        calculatePercentsForSelectedCapitalAccountingLines(capitalAccountingLinesFormBase);

        //setup the initial next sequence number column..
        setupIntialNextCapitalAssetLineNumber(capitalAccountingLinesFormBase);

        return mapping.findForward(RiceConstants.MAPPING_BASIC);
    }

    /**
     * All document-load operations get routed through here
     *
     * @see org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase#loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)
     */
    @Override
    protected void loadDocument(KualiDocumentFormBase kualiDocumentFormBase) throws WorkflowException {
        super.loadDocument(kualiDocumentFormBase);

        CapitalAccountingLinesFormBase capitalAccountingLinesFormBase = (CapitalAccountingLinesFormBase) kualiDocumentFormBase;
        String distributionAmountCode = capitalAccountingLinesFormBase.getCapitalAccountingLine().getDistributionCode();

        AccountingDocument tdoc = (AccountingDocument) kualiDocumentFormBase.getDocument();

        List<CapitalAccountingLines> capitalAccountingLines = new ArrayList();
        //for every source/target accounting line that has an object code that requires a
        //capital asset, creates a capital accounting line that the user can select to
        //perform create or modify asset functions.
        createCapitalAccountingLines(capitalAccountingLines, tdoc, distributionAmountCode);
        sortCaptitalAccountingLines(capitalAccountingLines);

        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) tdoc;
        caldb.setCapitalAccountingLines(capitalAccountingLines);
        //checks capital accounting lines for capital assets and if so checks the select box
        checkSelectForCapitalAccountingLines(capitalAccountingLinesFormBase);

        checkCapitalAccountingLinesSelected(capitalAccountingLinesFormBase);
        calculatePercentsForSelectedCapitalAccountingLines(capitalAccountingLinesFormBase);

        //setup the initial next sequence number column..
        setupIntialNextCapitalAssetLineNumber(kualiDocumentFormBase);

        KualiForm kualiForm = kualiDocumentFormBase;
        //based on the records in capital accounting lines, capital asset information lists
        //set the tabs to open if lists not empty else set to close
        setTabStatesForCapitalAssets(kualiForm);
    }

    /**
     *
     * @see org.kuali.rice.kns.web.struts.action.KualiAction#refresh(org.apache.struts.action.ActionMapping,
     *      org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
     */
   // @Override
    @Override
    public ActionForward refresh(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
        super.refresh(mapping, form, request, response);

        CapitalAccountingLinesFormBase capitalAccountingLinesFormBase = (CapitalAccountingLinesFormBase) form;
        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) capitalAccountingLinesFormBase.getFinancialDocument();

        List<CapitalAccountingLines> capitalAccountingLines = caldb.getCapitalAccountingLines();
        KualiDocumentFormBase kualiDocumentFormBase = (KualiDocumentFormBase) form;
        AccountingDocument tdoc = (AccountingDocument) kualiDocumentFormBase.getDocument();

        capitalAccountingLines = updateCapitalAccountingLines(capitalAccountingLines, tdoc);
        sortCaptitalAccountingLines(capitalAccountingLines);
        caldb.setCapitalAccountingLines(capitalAccountingLines);

        //now remove distributed accounting lines if they are not in the capital
        //accounting lines list.

        KualiAccountingDocumentFormBase kadfb = (KualiAccountingDocumentFormBase) form;
        List<CapitalAssetInformation> currentCapitalAssetInformation =  this.getCurrentCapitalAssetInformationObject(kadfb);

        removeOrphanDisributedAccountingLines(capitalAccountingLines, currentCapitalAssetInformation);
        checkCapitalAccountingLinesSelected(capitalAccountingLinesFormBase);
        setTabStatesForCapitalAssets(form);

        return mapping.findForward(OLEConstants.MAPPING_BASIC);
    }

    /**
     * When user adds an accounting line to the either source or target, if the object code on
     * that line has capital object type code group then a capital accounting line is created.
     * @see org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase#insertAccountingLine(boolean, org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase, org.kuali.ole.sys.businessobject.AccountingLine)
     */
    @Override
    protected void insertAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, AccountingLine line) {
        super.insertAccountingLine(isSource, financialDocumentForm, line);

        CapitalAccountingLinesFormBase capitalAccountingLinesFormBase = (CapitalAccountingLinesFormBase) financialDocumentForm;
        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) capitalAccountingLinesFormBase.getFinancialDocument();
        String distributionAmountCode = capitalAccountingLinesFormBase.getCapitalAccountingLine().getDistributionCode();

        List<CapitalAccountingLines> capitalAccountingLines = caldb.getCapitalAccountingLines();

        //create the corresponding capital accounting line and then
        //sort the capital accounting lines by object code and account number
        createCapitalAccountingLine(capitalAccountingLines, line, distributionAmountCode);
        sortCaptitalAccountingLines(capitalAccountingLines);

        KualiForm kualiForm = financialDocumentForm;
        //sets the tab states for create/modify capital asset tabs...
        setTabStatesForCapitalAssets(kualiForm);
    }

    /**
     * When user deletes an accounting line to the either source or target, the corresponding line in
     * capital accounting line is deleted and the distributed accounting line under the
     * created or modified capital asset line.  When a capital asset does not have any
     * accounting lines, the capital asset is removed.
     * @see org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase#deleteAccountingLine(boolean, org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase, int)
     */
    @Override
    protected void deleteAccountingLine(boolean isSource, KualiAccountingDocumentFormBase financialDocumentForm, int deleteIndex) {

        CapitalAccountingLinesFormBase capitalAccountingLinesFormBase = (CapitalAccountingLinesFormBase) financialDocumentForm;
        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) capitalAccountingLinesFormBase.getFinancialDocument();

        List<CapitalAccountingLines> capitalAccountingLines = caldb.getCapitalAccountingLines();

        if (isSource) {
            // remove from capital accounting lines for this source line
            AccountingLine line = (AccountingLine) financialDocumentForm.getFinancialDocument().getSourceAccountingLines().get(deleteIndex);
            deleteCapitalAccountingLine(capitalAccountingLines, line);
            deleteCapitalAssetLines(financialDocumentForm, line);
        }
        else {
            // remove from document
            AccountingLine line = (AccountingLine) financialDocumentForm.getFinancialDocument().getTargetAccountingLines().get(deleteIndex);
            deleteCapitalAccountingLine(capitalAccountingLines, line);
            deleteCapitalAssetLines(financialDocumentForm, line);
        }

        super.deleteAccountingLine(isSource, financialDocumentForm, deleteIndex);
        sortCaptitalAccountingLines(capitalAccountingLines);

        KualiForm kualiForm = financialDocumentForm;

        //checks capital accounting lines for capital assets and if so checks the select box
        checkSelectForCapitalAccountingLines(capitalAccountingLinesFormBase);
        checkCapitalAccountingLinesSelected(capitalAccountingLinesFormBase);
        calculatePercentsForSelectedCapitalAccountingLines(capitalAccountingLinesFormBase);
        setTabStatesForCapitalAssets(kualiForm);
    }

    /**
     * After uploading the accounting lines, the capital accounting lines will be created from these.
     * @see org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase#uploadAccountingLines(boolean, org.apache.struts.action.ActionForm)
     */
    @Override
    protected void uploadAccountingLines(boolean isSource, ActionForm form) throws FileNotFoundException, IOException {
        super.uploadAccountingLines(isSource, form);

        KualiAccountingDocumentFormBase kualiAccountingDocumentFormBase = (KualiAccountingDocumentFormBase) form;
        CapitalAccountingLinesFormBase capitalAccountingLinesFormBase = (CapitalAccountingLinesFormBase) form;
        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) capitalAccountingLinesFormBase.getFinancialDocument();

        String distributionAmountCode = capitalAccountingLinesFormBase.getCapitalAccountingLine().getDistributionCode();

        List<CapitalAccountingLines> capitalAccountingLines = caldb.getCapitalAccountingLines();
        AccountingDocument tdoc = (AccountingDocument) kualiAccountingDocumentFormBase.getDocument();

        createCapitalAccountingLines(capitalAccountingLines, tdoc, distributionAmountCode);
        sortCaptitalAccountingLines(capitalAccountingLines);

        KualiForm kualiForm = (KualiForm) form;
        setTabStatesForCapitalAssets(kualiForm);
    }

    /**
     * creates the capital accounting lines looking at source and/or target accounting lines.
     *
     * @param capitalAccountingLines
     * @param tdoc
     * @param distributionAmountCode distribution amount code for the line
     */
    protected void createCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, AccountingDocument tdoc, String distributionAmountCode) {
        List<SourceAccountingLine> sourceAccountLines = tdoc.getSourceAccountingLines();

        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) tdoc;

        for (SourceAccountingLine line : sourceAccountLines) {
            //create source capital accounting line
            createCapitalAccountingLine(capitalAccountingLines, line, distributionAmountCode);
        }

        List<TargetAccountingLine> targetAccountLines = tdoc.getTargetAccountingLines();

        for (TargetAccountingLine line : targetAccountLines) {
            // create target capital accounting line
            createCapitalAccountingLine(capitalAccountingLines, line, distributionAmountCode);
        }

        //sort the capital accounting lines collection
        sortCaptitalAccountingLines(capitalAccountingLines);
    }

    /**
     * updates the capital accounting lines looking at source and/or target accounting lines.
     *
     * @param capitalAccountingLines
     * @param tdoc
     */
    protected List<CapitalAccountingLines> updateCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, AccountingDocument tdoc) {
        List<SourceAccountingLine> sourceAccountLines = tdoc.getSourceAccountingLines();

        for (SourceAccountingLine line : sourceAccountLines) {
            //updates source capital accounting line
            updateCapitalAccountingLine(capitalAccountingLines, line);
        }

        List<TargetAccountingLine> targetAccountLines = tdoc.getTargetAccountingLines();

        for (TargetAccountingLine line : targetAccountLines) {
            //updates source capital accounting line
            updateCapitalAccountingLine(capitalAccountingLines, line);
        }

        //remove the orphan capital accounting lines that does not have corresponding
        //accounting line from either source or target.
       return removeOrphanCapitalAccountingLines(capitalAccountingLines, tdoc);
    }

    /**
     * updates the capital accounting lines looking at source and/or target accounting lines.
     * Removes any capital accounting line that does not have a corresponding
     * source or target accounting line.
     * @param capitalAccountingLines
     * @param tdoc
     */
    protected List<CapitalAccountingLines> removeOrphanCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, AccountingDocument tdoc) {
        List<CapitalAccountingLines> newCapitalAccountingLines = new ArrayList<CapitalAccountingLines>();
        if ( capitalAccountingLines != null ) {
        List<AccountingLine> sourceAccountLines = tdoc.getSourceAccountingLines();
        for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
            if (removeOrphanCapitalAccountingLine(sourceAccountLines, capitalAccountingLine)) {
                newCapitalAccountingLines.add(capitalAccountingLine);
            }
        }

        List<AccountingLine> targetAccountLines = tdoc.getTargetAccountingLines();
        for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
            if (removeOrphanCapitalAccountingLine(targetAccountLines, capitalAccountingLine)) {
                newCapitalAccountingLines.add(capitalAccountingLine);
            }
        }
        }
        return newCapitalAccountingLines;
    }

    /**
     * If the line exists in capital accounting lines, and that line does not exist in
     * accounting lines (source or target) then remove the line from capital accounting lines.
     *
     * @param capitalAccountingLines
     * @param line to remove
     * @return true if the capital accounting line to be removed is found in accounting lines, else false
     */
    protected boolean removeOrphanCapitalAccountingLine(List<AccountingLine> accountLines, CapitalAccountingLines capitalAccountingLine) {
        boolean found = false;

        for (AccountingLine accountingLine : accountLines) {
            if (capitalAccountingLine.getChartOfAccountsCode().equals(accountingLine.getChartOfAccountsCode()) &&
                    capitalAccountingLine.getAccountNumber().equals(accountingLine.getAccountNumber()) &&
                    capitalAccountingLine.getFinancialObjectCode().equals(accountingLine.getFinancialObjectCode()) &&
                    capitalAccountingLine.getLineType().equalsIgnoreCase(accountingLine instanceof SourceAccountingLine ? OLEConstants.SOURCE : OLEConstants.TARGET)) {
                found = true;
            }
        }

        return found;
    }

    /**
     * Method to check for any distributed accounting lines that are not listed in the
     * capital accounting lines and remove them.
     *
     * @param capitalAccountingLines
     * @param capitalAssets
     */
    protected void removeOrphanDisributedAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, List<CapitalAssetInformation> capitalAssets) {
        List<CapitalAssetInformation> removalCaiList = new ArrayList<CapitalAssetInformation>();

        for (CapitalAssetInformation capitalAsset : capitalAssets) {
            removeOrphanDisributedAccountingLine(capitalAccountingLines, capitalAsset);
            if (capitalAsset.getCapitalAssetAccountsGroupDetails().size() == 0) {
                capitalAsset.getCapitalAssetInformationDetails().clear();
                removalCaiList.add(capitalAsset);
            }
        }
        //if the removal list is not empty, remove these bunch of capital asset records
        //for that accounting line.
        if (ObjectUtils.isNotNull(removalCaiList)) {
            capitalAssets.removeAll(removalCaiList);
        }
    }

    /**
     * Method to check for any distributed accounting line for a given capital
     * accounting line that are not listed in the capital assets accounting lines and remove it.
     *
     * @param capitalAccountingLines
     * @param capitalAsset
     */
    protected void removeOrphanDisributedAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, CapitalAssetInformation capitalAsset) {
        List<CapitalAssetAccountsGroupDetails> groupAccountLines = capitalAsset.getCapitalAssetAccountsGroupDetails();
        CapitalAssetAccountsGroupDetails accountLineToDelete = null;

        for (CapitalAssetAccountsGroupDetails groupAccountLine : groupAccountLines) {
            if (!checkDistributedAccountingLineExists(capitalAccountingLines, groupAccountLine)) {
                accountLineToDelete = groupAccountLine;
                break;
            }
        }

        if (ObjectUtils.isNotNull(accountLineToDelete)) {
            // remove all the group accounting lines so that the asset line can be removed.
            capitalAsset.getCapitalAssetAccountsGroupDetails().clear();
        }
    }

    /**
     * checks capital accounting lines again the distributed accounting line and if found
     * return true else false so that this distributed accounting line may be removed.
     *
     * @param capitalAccountingLines
     * @param groupAccountLine
     * @return true if accounting line exists else return false
     */
    protected boolean checkDistributedAccountingLineExists(List<CapitalAccountingLines> capitalAccountingLines, CapitalAssetAccountsGroupDetails groupAccountLine) {
        boolean exists = false;

        for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
            if (groupAccountLine.getSequenceNumber().compareTo(capitalAccountingLine.getSequenceNumber()) == 0 &&
                    groupAccountLine.getFinancialDocumentLineTypeCode().equals(OLEConstants.SOURCE.equals(capitalAccountingLine.getLineType()) ? OLEConstants.SOURCE_ACCT_LINE_TYPE_CODE : OLEConstants.TARGET_ACCT_LINE_TYPE_CODE) &&
                    groupAccountLine.getChartOfAccountsCode().equals(capitalAccountingLine.getChartOfAccountsCode()) &&
                    groupAccountLine.getAccountNumber().equals(capitalAccountingLine.getAccountNumber()) &&
                    groupAccountLine.getFinancialObjectCode().equals(capitalAccountingLine.getFinancialObjectCode())) {
                return true;
            }
        }

        return false;
    }

    /**
     * Checks if the accounting line has an object code that belongs to object sub type group codes and
     * if so, creates a capital accounting line that will be displayed on the jsp.
     *
     * @param capitalAccountingLines
     * @param line
     * @param distributionAmountCode
     * @return List of capitalAccountingLines
     */
    protected List<CapitalAccountingLines> createCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line, String distributionAmountCode) {
        Integer sequenceNumber = capitalAccountingLines.size() + 1;

        if (capitalAssetBuilderModuleService.hasCapitalAssetObjectSubType(line)) {
            //capital object code so we need to build the capital accounting line...
            CapitalAccountingLines cal = addCapitalAccountingLine(capitalAccountingLines, line);
            cal.setDistributionAmountCode(distributionAmountCode);
            capitalAccountingLines.add(cal);
        }

        return capitalAccountingLines;
    }

    /**
     * Checks if the accounting line exits in the capital accounting lines
     * and if so, updates the other information.
     * else inserts a new record into the collection
     *
     * @param capitalAccountingLines
     * @param line
     * @return List of capitalAccountingLines
     */
    protected void updateCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line) {
        boolean found = false;

        for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
            if (capitalAccountingLine.getChartOfAccountsCode().equals(line.getChartOfAccountsCode()) &&
                    capitalAccountingLine.getAccountNumber().equals(line.getAccountNumber()) &&
                    capitalAccountingLine.getFinancialObjectCode().equals(line.getFinancialObjectCode()) &&
                    capitalAccountingLine.getLineType().equalsIgnoreCase(line instanceof SourceAccountingLine ? OLEConstants.SOURCE : OLEConstants.TARGET) &&
                    capitalAccountingLine.getSequenceNumber().compareTo(line.getSequenceNumber()) == 0) {
                capitalAccountingLine.setFinancialSubObjectCode(line.getFinancialSubObjectCode());
                capitalAccountingLine.setSubAccountNumber(line.getSubAccountNumber());
                capitalAccountingLine.setProjectCode(line.getProjectCode());
                capitalAccountingLine.setOrganizationReferenceId(line.getOrganizationReferenceId());
                capitalAccountingLine.setAmount(line.getAmount());
                capitalAccountingLine.setFinancialDocumentLineDescription(line.getFinancialDocumentLineDescription());
                found = true;
                break;
            }
        }

        if (!found) {
            //capital object code so we need to build the capital accounting line...
            if (capitalAssetBuilderModuleService.hasCapitalAssetObjectSubType(line)) {
                CapitalAccountingLines cal = addCapitalAccountingLine(capitalAccountingLines, line);
                capitalAccountingLines.add(cal);
            }
        }
    }

    /**
     * convenience method to add a new capital accounting line to the collection of capital
     * accounting lines.
     *
     * @param capitalAccountingLines
     * @param line
     * @return cal newly created capital accounting line
     */
    protected CapitalAccountingLines addCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line) {
        CapitalAccountingLines cal = new CapitalAccountingLines();

        if (line instanceof SourceAccountingLine) {
            cal.setLineType(OLEConstants.SOURCE);
        }
        else {
            cal.setLineType(OLEConstants.TARGET);
        }
        cal.setSequenceNumber(line.getSequenceNumber());
        cal.setChartOfAccountsCode(line.getChartOfAccountsCode());
        cal.setAccountNumber(line.getAccountNumber());
        cal.setSubAccountNumber(line.getSubAccountNumber());
        cal.setFinancialObjectCode(line.getFinancialObjectCode());
        cal.setFinancialSubObjectCode(line.getFinancialSubObjectCode());
        cal.setProjectCode(line.getProjectCode());
        cal.setOrganizationReferenceId(line.getOrganizationReferenceId());
        cal.setFinancialDocumentLineDescription(line.getFinancialDocumentLineDescription());
        cal.setAmount(line.getAmount());
        cal.setAccountLinePercent(null);
        cal.setSelectLine(false);

        return cal;
    }

    /**
     * If the line exists in capital accounting lines, that will be deleted.
     *
     * @param capitalAccountingLines
     * @param line to remove
     * @return List of capitalAccountingLines
     */
    protected List<CapitalAccountingLines> deleteCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line) {
        CapitalAccountingLines cal = null;

        for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
            if (capitalAccountingLine.getChartOfAccountsCode().equals(line.getChartOfAccountsCode()) &&
                    capitalAccountingLine.getAccountNumber().equals(line.getAccountNumber()) &&
                    capitalAccountingLine.getFinancialObjectCode().equals(line.getFinancialObjectCode()) &&
                    capitalAccountingLine.getLineType().equalsIgnoreCase(line instanceof SourceAccountingLine ? OLEConstants.SOURCE : OLEConstants.TARGET)) {
                cal = capitalAccountingLine;
                break;
            }
        }

        if (ObjectUtils.isNotNull(cal)) {
            capitalAccountingLines.remove(cal);
        }

        return capitalAccountingLines;
    }

    /**
     * sort the capital accounting lines collection based on financial object code and account number.
     * @param capitalAccountingLines List of capital accounting lines
     */
    protected void sortCaptitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines) {
        CapitalAccountingLinesComparator calComparator = new CapitalAccountingLinesComparator();

        //sort the collection based on financial object code and account number
        Collections.sort(capitalAccountingLines, calComparator);
    }

    /**
     * Action "create" creates assets for the selected capital
     * accounting lines.  An error message is shown if no capital accounting lines
     * are selected for processing.  The action checks if the selected
     * capital accounting lines object sub type cross based on the system paramter
     * values for the object subtypes and if so prompts the user to confirm to continue
     * to create the assets for the select capital accounting lines.
     *
     * @param mapping
     * @param form
     * @param request
     * @param response
     * @return ActionForward
     * @throws Exception
     */
    public ActionForward createAsset(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
        CapitalAccountingLinesFormBase calfb = (CapitalAccountingLinesFormBase) form;
        String distributionAmountCode = calfb.getCapitalAccountingLine().getDistributionCode();
        if (OLEConstants.CapitalAssets.DISTRIBUTE_COST_EQUALLY_CODE.equals(distributionAmountCode)) {
           calfb.setDistributeEqualAmount(true);
        }
        else {
            calfb.setDistributeEqualAmount(false);
        }

        boolean createAction = calfb.getCapitalAccountingLine().isCanCreateAsset();
        calfb.setEditCreateOrModify(false);

        GlobalVariables.getMessageMap().clearErrorMessages();
        if (!capitalAccountingLinesSelected(calfb)) {
            GlobalVariables.getMessageMap().putError(OLEConstants.EDIT_ACCOUNTING_LINES_FOR_CAPITALIZATION_ERRORS, OLEKeyConstants.ERROR_DOCUMENT_ACCOUNTING_LINE_FOR_CAPITALIZATAION_REQUIRED_CREATE);
            return mapping.findForward(OLEConstants.MAPPING_BASIC);
        }
        else {
            calfb.setEditCreateOrModify(false);
        }

        Document document = calfb.getFinancialDocument();

        //if same object subtypes then continue creating capital assets....
        if (checkObjecSubTypeCrossingCapitalAccountingLines(document)) {
            //question the user if to continue....
            ActionForward forward = performQuestionPrompt(mapping, form, request, response, OLEConstants.CapitalAssets.CAPITAL_ASSET_CREATE_ACTION_INDICATOR, distributionAmountCode);
            if (forward != null) {
                return forward;
            }
        }
        else {
            createCapitalAssetsForSelectedAccountingLines(form , calfb, OLEConstants.CapitalAssets.CAPITAL_ASSET_CREATE_ACTION_INDICATOR, distributionAmountCode);
        }

        //restore the tab states....
        setTabStatesForCapitalAssets(form);

        return mapping.findForward(OLEConstants.MAPPING_BASIC);
    }

    /**
     * Action "modify" creates assets for the selected capital
     * accounting lines.  An error message is shown if no capital accounting lines
     * are selected for processing.  The action checks if the selected
     * capital accounting lines object sub type cross based on the system paramter
     * values for the object subtypes and if so prompts the user to confirm to continue
     * to create the assets for the select capital accounting lines.
     *
     * @param mapping
     * @param form
     * @param request
     * @param response
     * @return ActionForward
     * @throws Exception
     */
    public ActionForward modifyAsset(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
        CapitalAccountingLinesFormBase calfb = (CapitalAccountingLinesFormBase) form;
        String distributionAmountCode = calfb.getCapitalAccountingLine().getDistributionCode();

        if (OLEConstants.CapitalAssets.DISTRIBUTE_COST_EQUALLY_CODE.equals(distributionAmountCode)) {
            calfb.setDistributeEqualAmount(true);
         }
        else {
            calfb.setDistributeEqualAmount(false);
        }

        GlobalVariables.getMessageMap().clearErrorMessages();
        if (!capitalAccountingLinesSelected(calfb)) {
            GlobalVariables.getMessageMap().putError(OLEConstants.EDIT_ACCOUNTING_LINES_FOR_CAPITALIZATION_ERRORS, OLEKeyConstants.ERROR_DOCUMENT_ACCOUNTING_LINE_FOR_CAPITALIZATAION_REQUIRED_MODIFY);
            return mapping.findForward(OLEConstants.MAPPING_BASIC);
        }
        else {
            calfb.setEditCreateOrModify(false);
        }

        Document document = calfb.getFinancialDocument();

        //if same object subtypes then continue creating capital assets....
        if (checkObjecSubTypeCrossingCapitalAccountingLines(document)) {
            //question the user if to continue....
            ActionForward forward = performQuestionPrompt(mapping, form, request, response, OLEConstants.CapitalAssets.CAPITAL_ASSET_MODIFY_ACTION_INDICATOR, distributionAmountCode);
            if (forward != null) {
                return forward;
            }
        }
        else {
            createCapitalAssetsForSelectedAccountingLines(form , calfb, OLEConstants.CapitalAssets.CAPITAL_ASSET_MODIFY_ACTION_INDICATOR, distributionAmountCode);
        }

        //restore the tab states....
        setTabStatesForCapitalAssets(form);

        return mapping.findForward(OLEConstants.MAPPING_BASIC);
    }

    /**
     * Helper method to first calculate the percents for the selected capital accounting lines as
     * the percent is required if the user is distributing the amounts by individual amount
     * method.  It then populates created or modified assets with asset accounting lines.
     *
     * @param form
     * @param calfb
     * @param actionTypeIndicator indicates whether creating an asset for "create" or "modify" actions.
     * @param distributionAmountCode amount distribution code
     */
    protected void createCapitalAssetsForSelectedAccountingLines(ActionForm form, CapitalAccountingLinesFormBase calfb, String actionTypeIndicator, String distributionAmountCode) {
        calculatePercentsForSelectedCapitalAccountingLines(calfb);
        createCapitalAssetForGroupAccountingLines(calfb, actionTypeIndicator, distributionAmountCode);
            checkCapitalAccountingLinesSelected(calfb);

            KualiForm kualiForm = (KualiForm) form;
            setTabStatesForCapitalAssets(kualiForm);
        }


    /**
     * checks the capital accounting lines if any of the lines have been selected for
     * further processing.
     *
     * @param calfb
     * @return selected return true if lines have been selected else return false
     */
    protected boolean capitalAccountingLinesSelected(CapitalAccountingLinesFormBase calfb) {
        boolean selected = false;

        CapitalAccountingLinesDocumentBase caldb = (CapitalAccountingLinesDocumentBase) calfb.getFinancialDocument();
        List<CapitalAccountingLines> capitalAccountingLines = caldb.getCapitalAccountingLines();

        for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
            if (capitalAccountingLine.isSelectLine()) {
                selected = true;
                break;
            }
        }

        return selected;
    }

   /**
    * runs the validation to check if object subtypes crosses groups on
    * selected capital accounting lines.
    *
    * @param form
    * @return true if rule passed else false
    */
    protected boolean checkObjecSubTypeCrossingCapitalAccountingLines(Document document) {
        boolean differentObjecSubtypes = true;
        differentObjecSubtypes &= getRuleService().applyRules(new CapitalAccountingLinesSameObjectCodeSubTypeEvent(document));

        return differentObjecSubtypes;
    }

    /**
     *
     * @param mapping An ActionMapping
     * @param form An ActionForm
     * @param request The HttpServletRequest
     * @param response The HttpServletResponse
     * @throws Exception
     * @param distributionAmountCode
     * @return An ActionForward
     */
    protected ActionForward performQuestionPrompt(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response, String actionTypeCode, String distributionAmountCode) throws Exception {
        ActionForward forward = null;
        Object question = request.getParameter(OLEConstants.QUESTION_INST_ATTRIBUTE_NAME);
        CapitalAccountingLinesFormBase calfb = (CapitalAccountingLinesFormBase) form;

        if (question == null) {
            String questionText = SpringContext.getBean(ConfigurationService.class).getPropertyValueAsString(OLEKeyConstants.WARNING_NOT_SAME_OBJECT_SUB_TYPES);
            return this.performQuestionWithoutInput(mapping, form, request, response, OLEConstants.OBJECT_SUB_TYPES_DIFFERENT_QUESTION, questionText, OLEConstants.CONFIRMATION_QUESTION, OLEConstants.ROUTE_METHOD, "");
        }
        else {
            Object buttonClicked = request.getParameter(OLEConstants.QUESTION_CLICKED_BUTTON);
            // If the user replies 'Yes' the question, proceed..
            if (OLEConstants.OBJECT_SUB_TYPES_DIFFERENT_QUESTION.equals(question) && ConfirmationQuestion.YES.equals(buttonClicked)) {
                createCapitalAssetsForSelectedAccountingLines(form , calfb, actionTypeCode, distributionAmountCode);
                
                KualiForm kualiForm = (KualiForm) form;
                setTabStatesForCapitalAssets(kualiForm);

                return mapping.findForward(OLEConstants.MAPPING_BASIC);

            }
            // If the user replies 'No' to either of the questions
            else {
                uncheckCapitalAccountingLinesSelected(calfb);
                forward = mapping.findForward(OLEConstants.MAPPING_BASIC);
            }
        }

        return forward;
    }

    /**
     * Get the rule service
     *
     * @return ruleService
     */
    protected KualiRuleService getRuleService() {
        return SpringContext.getBean(KualiRuleService.class);
    }
}