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.module.ar.document.validation.impl;
017    
018    import static org.kuali.kfs.sys.document.validation.impl.AccountingDocumentRuleBaseConstants.ERROR_PATH.DOCUMENT_ERROR_PREFIX;
019    
020    import java.math.BigDecimal;
021    
022    import org.kuali.kfs.module.ar.ArConstants;
023    import org.kuali.kfs.module.ar.ArKeyConstants;
024    import org.kuali.kfs.module.ar.ArPropertyConstants;
025    import org.kuali.kfs.module.ar.businessobject.CustomerCreditMemoDetail;
026    import org.kuali.kfs.module.ar.document.CustomerCreditMemoDocument;
027    import org.kuali.kfs.sys.KFSConstants;
028    import org.kuali.kfs.sys.document.validation.GenericValidation;
029    import org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent;
030    import org.kuali.rice.kns.util.GlobalVariables;
031    import org.kuali.rice.kns.util.KualiDecimal;
032    import org.kuali.rice.kns.util.ObjectUtils;
033    
034    public class CustomerCreditMemoDetailQuantityAndAmountValidation extends GenericValidation {
035    
036        protected KualiDecimal getAllowedQtyDeviation() {
037            return new KualiDecimal("0.10");
038        }
039    
040        private CustomerCreditMemoDetail customerCreditMemoDetail;
041        
042        public boolean validate(AttributedDocumentEvent event) {
043    
044            KualiDecimal creditAmount = customerCreditMemoDetail.getCreditMemoItemTotalAmount();
045            BigDecimal quantity = customerCreditMemoDetail.getCreditMemoItemQuantity();
046            BigDecimal unitPrice = customerCreditMemoDetail.getCustomerInvoiceDetail().getInvoiceItemUnitPrice();
047            boolean validValue;
048            
049            if (ObjectUtils.isNotNull(quantity) && ObjectUtils.isNotNull(creditAmount)) {
050    
051                //  determine the expected exact total credit memo quantity, based on actual credit amount entered
052                KualiDecimal creditQuantity = new KualiDecimal(customerCreditMemoDetail.getCreditMemoItemQuantity());
053                KualiDecimal expectedCreditQuantity = creditAmount.divide(new KualiDecimal(unitPrice), true);
054            
055                //  determine the deviation percentage that the actual creditQuantity has from expectedCreditQuantity
056                KualiDecimal deviationPercentage = expectedCreditQuantity.subtract(creditQuantity).abs().divide(expectedCreditQuantity);
057            
058                // only allow a certain deviation of creditQuantity from the expectedCreditQuantity 
059                validValue = (deviationPercentage.isLessEqual(getAllowedQtyDeviation()));
060                if (!validValue){
061                    GlobalVariables.getMessageMap().putError(ArPropertyConstants.CustomerCreditMemoDocumentFields.CREDIT_MEMO_ITEM_QUANTITY, ArKeyConstants.ERROR_CUSTOMER_CREDIT_MEMO_DETAIL_INVALID_DATA_INPUT);
062                    GlobalVariables.getMessageMap().putError(ArPropertyConstants.CustomerCreditMemoDocumentFields.CREDIT_MEMO_ITEM_TOTAL_AMOUNT, ArKeyConstants.ERROR_CUSTOMER_CREDIT_MEMO_DETAIL_INVALID_DATA_INPUT);
063                }
064            }
065            return true;
066        }    
067        
068        public CustomerCreditMemoDetail getCustomerCreditMemoDetail() {
069            return customerCreditMemoDetail;
070        }
071    
072        public void setCustomerCreditMemoDetail(CustomerCreditMemoDetail customerCreditMemoDetail) {
073            this.customerCreditMemoDetail = customerCreditMemoDetail;
074        }
075    
076    
077    
078    }