/*
    * Copyright 2009 The Kuali Foundation.
    * 
    * Licensed under the Educational Community License, Version 1.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/ecl1.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.sec.document.validation.impl;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import org.kuali.ole.sec.SecKeyConstants;
  import org.kuali.ole.sec.businessobject.SecurityDefinition;
  import org.kuali.ole.sys.OLEPropertyConstants;
  import org.kuali.rice.kns.document.MaintenanceDocument;
  import org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase;
  import org.kuali.rice.krad.util.GlobalVariables;
  import org.kuali.rice.krad.util.KRADConstants;
  
  
  /**
   * Implements business rules checks on the SecurityDefinition maintenance document
   */
  public class SecurityDefinitionRule extends MaintenanceDocumentRuleBase {
      protected static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(SecurityDefinitionRule.class);
  
      protected SecurityDefinition oldSecurityDefinition;
      protected SecurityDefinition newSecurityDefinition;
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      @Override
      protected boolean processCustomApproveDocumentBusinessRules(MaintenanceDocument document) {
          boolean isValid = super.processCustomApproveDocumentBusinessRules(document);
  
          if (!isValid) {
              return isValid;
          }
  
          boolean isMaintenanceEdit = document.isEdit();
  
          isValid &= validateSecurityDefinition(isMaintenanceEdit);
  
          return isValid;
      }
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      @Override
      protected boolean processCustomRouteDocumentBusinessRules(MaintenanceDocument document) {
          boolean isValid = super.processCustomRouteDocumentBusinessRules(document);
  
          if (!isValid) {
              return isValid;
          }
  
          boolean isMaintenanceEdit = document.isEdit();
  
          isValid &= validateSecurityDefinition(isMaintenanceEdit);
  
          return isValid;
      }
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#setupConvenienceObjects()
       */
      @Override
      public void setupConvenienceObjects() {
          oldSecurityDefinition = (SecurityDefinition) super.getOldBo();
          newSecurityDefinition = (SecurityDefinition) super.getNewBo();
      }
  
      /**
       * Validates business rules against a security definition record
       * 
       * @param isMaintenanceEdit boolean indicating whether the maintenance action is an edit (true), or a new/copy (false)
       * @return boolean true if all rules pass, false if at least one fails
       */
      protected boolean validateSecurityDefinition(boolean isMaintenanceEdit) {
          boolean isValid = true;
  
          if (!isMaintenanceEdit) {
              boolean validDefinitionName = verifyDefinitionNameIsUnique(newSecurityDefinition, KRADConstants.MAINTENANCE_NEW_MAINTAINABLE);
              if (!validDefinitionName) {
                  isValid = false;
              }
          }
  
         return isValid;
     }
 
     /**
      * For new or copy action verifies the name given for the definition is not being used by another definition
      * 
      * @param securityDefinition SecurityDefinition with name to check
      * @param errorKeyPrefix String errorPrefix to use if any errors are found
      * @return boolean true if name exists, false if not
      */
     protected boolean verifyDefinitionNameIsUnique(SecurityDefinition securityDefinition, String errorKeyPrefix) {
         boolean isValid = true;
 
         Map<String, String> searchValues = new HashMap<String, String>();
         searchValues.put(OLEPropertyConstants.NAME, securityDefinition.getName());
 
         int matchCount = getBoService().countMatching(SecurityDefinition.class, searchValues);
         if (matchCount > 0) {
             GlobalVariables.getMessageMap().putError(errorKeyPrefix + OLEPropertyConstants.NAME, SecKeyConstants.ERROR_DEFINITION_NAME_NON_UNIQUE, securityDefinition.getName());
             isValid = false;
         }
         // TODO: check if KIM role exists - fail if present
 
         return isValid;
     }
 
 
 }