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.purap.document.validation.impl;
017    
018    import java.util.ArrayList;
019    
020    import org.kuali.kfs.module.purap.PurapConstants;
021    import org.kuali.kfs.module.purap.PurapKeyConstants;
022    import org.kuali.kfs.module.purap.document.PaymentRequestDocument;
023    import org.kuali.kfs.module.purap.document.service.PurapService;
024    import org.kuali.kfs.sys.KFSPropertyConstants;
025    import org.kuali.kfs.sys.document.validation.GenericValidation;
026    import org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent;
027    import org.kuali.rice.kns.util.GlobalVariables;
028    import org.kuali.rice.kns.util.MessageList;
029    import org.kuali.rice.kns.util.ObjectUtils;
030    
031    public class PaymentRequestPayDateNotOverThresholdDaysAwayValidation extends GenericValidation {
032    
033        private PurapService purapService;
034        
035        /**
036         * This method side-effects a warning, and consequently should not be used in such a way as to cause validation to fail. Returns
037         * a boolean for ease of testing. If the threshold days value is positive, the method will test future dates accurately. If the
038         * the threshold days value is negative, the method will test past dates.
039         * 
040         */
041        public boolean validate(AttributedDocumentEvent event) {
042            PaymentRequestDocument document = (PaymentRequestDocument)event.getDocument();
043            GlobalVariables.getMessageMap().clearErrorPath();
044            GlobalVariables.getMessageMap().addToErrorPath(KFSPropertyConstants.DOCUMENT);
045            
046            int thresholdDays = PurapConstants.PREQ_PAY_DATE_DAYS_BEFORE_WARNING;
047            if ((document.getPaymentRequestPayDate() != null) && purapService.isDateMoreThanANumberOfDaysAway(document.getPaymentRequestPayDate(), thresholdDays)) {
048                if (ObjectUtils.isNull(GlobalVariables.getMessageList())) {
049                    GlobalVariables.setMessageList(new MessageList());
050                }
051                if (!GlobalVariables.getMessageList().contains(PurapKeyConstants.WARNING_PAYMENT_REQUEST_PAYDATE_OVER_THRESHOLD_DAYS)) {
052                    GlobalVariables.getMessageList().add(PurapKeyConstants.WARNING_PAYMENT_REQUEST_PAYDATE_OVER_THRESHOLD_DAYS);
053                }            
054            }
055            
056            GlobalVariables.getMessageMap().clearErrorPath();
057            
058            //always returns true, as this is a warning, not an error
059            return true;
060        }
061    
062        public PurapService getPurapService() {
063            return purapService;
064        }
065    
066        public void setPurapService(PurapService purapService) {
067            this.purapService = purapService;
068        }
069    
070    }