/*
    * Copyright 2008-2009 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.fp.document.validation.impl;
  
  import static org.kuali.ole.sys.OLEPropertyConstants.REFERENCE_NUMBER;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.fp.document.NonCheckDisbursementDocument;
  import org.kuali.ole.sys.OLEKeyConstants;
  import org.kuali.ole.sys.businessobject.AccountingLine;
  import org.kuali.ole.sys.document.validation.GenericValidation;
  import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
  import org.kuali.rice.kns.service.DataDictionaryService;
  import org.kuali.rice.krad.datadictionary.BusinessObjectEntry;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * Validates that an accounting line has a reference number 
   */
  public class NonCheckDisbursementRequiredReferenceFieldValidation extends GenericValidation {
      private DataDictionaryService dataDictionaryService;
      private AccountingLine accountingLineForValidation;
  
      /**
       * determines if a reference number has been added to the Accounting Line
       * <strong>Expects an accounting line as the first a parameter</strong>
       * @see org.kuali.ole.sys.document.validation.Validation#validate(java.lang.Object[])
       */
      
      
      public boolean validate(AttributedDocumentEvent event) {
          
          NonCheckDisbursementDocument document = (NonCheckDisbursementDocument)event.getDocument();
          
          boolean valid = true;
          Class alclass = null;
          BusinessObjectEntry boe;
  
          if (accountingLineForValidation.isSourceAccountingLine()) {
              alclass = document.getSourceAccountingLineClass();
          }
          else if (accountingLineForValidation.isTargetAccountingLine()) {
              alclass = document.getTargetAccountingLineClass();
          }
  
          boe = getDataDictionaryService().getDataDictionary().getBusinessObjectEntry(alclass.getName());
         
          if (StringUtils.isEmpty(accountingLineForValidation.getReferenceNumber())) {
              putRequiredPropertyError(boe, REFERENCE_NUMBER);
              valid = false;
          }
          return valid;
      }
  
      /**
       * Adds a global error for a missing required property. This is used for properties, such as reference origin code, which cannot
       * be required by the DataDictionary validation because not all documents require them.
       * 
       * @param boe
       * @param propertyName
       */
      protected void putRequiredPropertyError(BusinessObjectEntry boe, String propertyName) {
  
          String label = boe.getAttributeDefinition(propertyName).getShortLabel();
          GlobalVariables.getMessageMap().putError(propertyName, OLEKeyConstants.ERROR_REQUIRED, label);
  
      }
  
      /**
       * Gets the accountingLineForValidation attribute. 
       * @return Returns the accountingLineForValidation.
       */
      public AccountingLine getAccountingLineForValidation() {
          return accountingLineForValidation;
      }
  
      /**
       * Sets the accountingLineForValidation attribute value.
       * @param accountingLineForValidation The accountingLineForValidation to set.
       */
      public void setAccountingLineForValidation(AccountingLine accountingLineForValidation) {
          this.accountingLineForValidation = accountingLineForValidation;
      }
  
      /**
       * Gets the dataDictionaryService attribute. 
      * @return Returns the dataDictionaryService.
      */
     public DataDictionaryService getDataDictionaryService() {
         return dataDictionaryService;
     }
 
     /**
      * Sets the dataDictionaryService attribute value.
      * @param dataDictionaryService The dataDictionaryService to set.
      */
     public void setDataDictionaryService(DataDictionaryService dataDictionaryService) {
         this.dataDictionaryService = dataDictionaryService;
     }
 }