001/*
002 * Copyright 2008 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.module.purap.document.validation.impl;
017
018import org.kuali.ole.module.purap.PurapKeyConstants;
019import org.kuali.ole.module.purap.PurapPropertyConstants;
020import org.kuali.ole.module.purap.document.InvoiceDocument;
021import org.kuali.ole.module.purap.document.service.PurapService;
022import org.kuali.ole.sys.OLEPropertyConstants;
023import org.kuali.ole.sys.document.validation.GenericValidation;
024import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
025import org.kuali.rice.kew.api.WorkflowDocument;
026import org.kuali.rice.krad.service.BusinessObjectService;
027import org.kuali.rice.krad.service.PersistenceService;
028import org.kuali.rice.krad.util.GlobalVariables;
029import org.kuali.rice.krad.util.ObjectUtils;
030
031import java.util.Map;
032
033public class InvoicePayDateNotPastValidation extends GenericValidation {
034
035    private PurapService purapService;
036    private PersistenceService persistenceService;
037    private BusinessObjectService businessObjectService;
038
039    /**
040     * Validates that the payment request date does not occur in the past.
041     */
042    public boolean validate(AttributedDocumentEvent event) {
043        boolean valid = true;
044        InvoiceDocument document = (InvoiceDocument) event.getDocument();
045        GlobalVariables.getMessageMap().clearErrorPath();
046        GlobalVariables.getMessageMap().addToErrorPath(OLEPropertyConstants.DOCUMENT);
047
048        java.sql.Date invoicePayDate = document.getInvoicePayDate();
049        if (ObjectUtils.isNotNull(invoicePayDate) && purapService.isDateInPast(invoicePayDate)) {
050            // the pay date is in the past, now we need to check whether given the state of the document to determine whether a past pay date is allowed
051            WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
052            if (workflowDocument.isInitiated() || workflowDocument.isSaved()) {
053                // past pay dates are not allowed if the document has never been routed (i.e. in saved or initiated state)
054                // (note that this block will be run when a document is being routed, or re-saved after being routed
055                valid &= false;
056                GlobalVariables.getMessageMap().putError(PurapPropertyConstants.PAYMENT_REQUEST_PAY_DATE, PurapKeyConstants.ERROR_INVALID_PAY_DATE);
057            } else {
058                // otherwise, this document has already been routed
059                // it's an error if the pay date has been changed from the pay date in the database and the new pay date is in the past
060                // retrieve doc from DB, and compare the dates
061                InvoiceDocument invoiceDocumentFromDatabase = retrieveInvoiceDocumentFromDatabase(document);
062
063                if (ObjectUtils.isNull(invoiceDocumentFromDatabase)) {
064                    // this definitely should not happen
065                    throw new NullPointerException("Unable to find payment request document " + document.getDocumentNumber() + " from database");
066                }
067
068                java.sql.Date invoicePayDateFromDatabase = invoiceDocumentFromDatabase.getInvoicePayDate();
069                if (ObjectUtils.isNull(invoicePayDateFromDatabase) || !invoicePayDateFromDatabase.equals(invoicePayDate)) {
070                    valid &= false;
071                    GlobalVariables.getMessageMap().putError(PurapPropertyConstants.PAYMENT_REQUEST_PAY_DATE, PurapKeyConstants.ERROR_INVALID_PAY_DATE);
072                }
073            }
074        }
075
076        GlobalVariables.getMessageMap().clearErrorPath();
077
078        return valid;
079    }
080
081    /**
082     * Retrieves the payment request document from the database.  Note that the instance returned
083     *
084     * @param document the document to look in the database for
085     * @return an instance representing what's stored in the database for this instance
086     */
087    protected InvoiceDocument retrieveInvoiceDocumentFromDatabase(InvoiceDocument document) {
088        Map primaryKeyValues = persistenceService.getPrimaryKeyFieldValues(document);
089        return (InvoiceDocument) businessObjectService.findByPrimaryKey(document.getClass(), primaryKeyValues);
090    }
091
092    public PurapService getPurapService() {
093        return purapService;
094    }
095
096    public void setPurapService(PurapService purapService) {
097        this.purapService = purapService;
098    }
099
100    public PersistenceService getPersistenceService() {
101        return persistenceService;
102    }
103
104    public void setPersistenceService(PersistenceService persistenceService) {
105        this.persistenceService = persistenceService;
106    }
107
108    public BusinessObjectService getBusinessObjectService() {
109        return businessObjectService;
110    }
111
112    public void setBusinessObjectService(BusinessObjectService businessObjectService) {
113        this.businessObjectService = businessObjectService;
114    }
115
116}