/*
    * Copyright 2007-2008 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.module.purap.document.validation.impl;
  
  import org.kuali.ole.module.purap.PurapKeyConstants;
  import org.kuali.ole.module.purap.businessobject.VendorStipulation;
  import org.kuali.rice.kns.document.MaintenanceDocument;
  import org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase;
  import org.kuali.rice.krad.service.BusinessObjectService;
  
  import java.util.HashMap;
  import java.util.Map;
  
  /**
   * Business rule(s) applicable to Purchase Order Contract Language maintenance document.
   */
  public class VendorStipulationRule extends MaintenanceDocumentRuleBase {
  
      private VendorStipulation newStipulation;
      private VendorStipulation oldStipulation;
      private BusinessObjectService boService;
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#setupConvenienceObjects()
       */
      @Override
      public void setupConvenienceObjects() {
          // setup newDelegateChange convenience objects, make sure all possible sub-objects are populated
          newStipulation = (VendorStipulation) super.getNewBo();
          oldStipulation = (VendorStipulation) super.getOldBo();
          boService = (BusinessObjectService) super.getBoService();
          super.setupConvenienceObjects();
      }
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      protected boolean processCustomApproveDocumentBusinessRules(MaintenanceDocument document) {
          LOG.info("processCustomApproveDocumentBusinessRules called");
          this.setupConvenienceObjects();
          boolean success = this.checkForDuplicate();
          return success && super.processCustomApproveDocumentBusinessRules(document);
      }
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      protected boolean processCustomRouteDocumentBusinessRules(MaintenanceDocument document) {
          LOG.info("processCustomRouteDocumentBusinessRules called");
          this.setupConvenienceObjects();
          boolean success = this.checkForDuplicate();
          return success && super.processCustomRouteDocumentBusinessRules(document);
      }
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      protected boolean processCustomSaveDocumentBusinessRules(MaintenanceDocument document) {
          LOG.info("processCustomSaveDocumentBusinessRules called");
          this.setupConvenienceObjects();
          boolean success = this.checkForDuplicate();
          return success && super.processCustomSaveDocumentBusinessRules(document);
      }
  
      /**
       * Check to see if data duplicates existing data.
       *
       * @return boolean indicating if validation succeeded.
       */
      protected boolean checkForDuplicate() {
          LOG.info("checkForDuplicate called");
          boolean success = true;
          Map fieldValues = new HashMap();
  
          if (oldStipulation.getVendorStipulationIdentifier() != null && newStipulation.getVendorStipulationIdentifier() != null &&
                  oldStipulation.getVendorStipulationIdentifier().equals(newStipulation.getVendorStipulationIdentifier()) &&
                  oldStipulation.getVendorStipulationName().equals(newStipulation.getVendorStipulationName())) {
              return true;
          } else {
              fieldValues.put("vendorStipulationName", newStipulation.getVendorStipulationName());
              if (boService.countMatching(newStipulation.getClass(), fieldValues) != 0) {
                  success &= false;
                  putGlobalError(PurapKeyConstants.PURAP_GENERAL_POTENTIAL_DUPLICATE);
              }
          }
  
         return success;
     }
 }