/**
    * Copyright 2005-2011 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.rice.krad.datadictionary;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.rice.krad.bo.BusinessObject;
  import org.kuali.rice.krad.datadictionary.exception.ClassValidationException;
  
  import java.util.List;
  
  /**
   * A single BusinessObject entry in the DataDictionary, which contains information relating to the display, validation,
   * and general maintenance of a BusinessObject and its attributes.
   *
   * Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public class BusinessObjectEntry extends DataObjectEntry {
  
      protected Class<? extends BusinessObject> baseBusinessObjectClass;
  
      public void setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass) {
          super.setDataObjectClass(businessObjectClass);
  
          if (businessObjectClass == null) {
              throw new IllegalArgumentException("invalid (null) dataObjectClass");
          }
  
          if (getRelationships() != null) {
              for (RelationshipDefinition rd : getRelationships()) {
                  rd.setSourceClass(businessObjectClass);
              }
          }
      }
  
      public Class<? extends BusinessObject> getBusinessObjectClass() {
          return (Class<? extends BusinessObject>) super.getDataObjectClass();
      }
  
      /**
       * The baseBusinessObjectClass is an optional parameter for specifying a superclass
       * for the dataObjectClass, allowing the data dictionary to index by superclass
       * in addition to the current class.
       */
  
      public void setBaseBusinessObjectClass(Class<? extends BusinessObject> baseBusinessObjectClass) {
          this.baseBusinessObjectClass = baseBusinessObjectClass;
      }
  
      public Class<? extends BusinessObject> getBaseBusinessObjectClass() {
          return baseBusinessObjectClass;
      }
  
      /**
       * Directly validate simple fields, call completeValidation on Definition fields.
       */
      @Override
      public void completeValidation() {
          try {
  
              if (baseBusinessObjectClass != null && !baseBusinessObjectClass.isAssignableFrom(getDataObjectClass())) {
                  throw new ClassValidationException("The baseBusinessObjectClass " + baseBusinessObjectClass.getName() +
                          " is not a superclass of the dataObjectClass " + getDataObjectClass().getName());
              }
  
              super.completeValidation();
  
              if (inactivationBlockingDefinitions != null && !inactivationBlockingDefinitions.isEmpty()) {
                  for (InactivationBlockingDefinition inactivationBlockingDefinition : inactivationBlockingDefinitions) {
                      inactivationBlockingDefinition.completeValidation(getDataObjectClass(), null);
                  }
              }
          } catch (DataDictionaryException ex) {
              // just rethrow
              throw ex;
          } catch (Exception ex) {
              throw new DataDictionaryException("Exception validating " + this, ex);
          }
      }
  
      /**
       * @see org.kuali.rice.krad.datadictionary.DataDictionaryEntryBase#afterPropertiesSet()
       */
      @SuppressWarnings("unchecked")
      @Override
     public void afterPropertiesSet() throws Exception {
         super.afterPropertiesSet();
         if (inactivationBlockingDefinitions != null) {
             for (InactivationBlockingDefinition ibd : inactivationBlockingDefinitions) {
                 ibd.setBusinessObjectClass(getBusinessObjectClass());
                 if (StringUtils.isNotBlank(ibd.getBlockedReferencePropertyName()) &&
                         ibd.getBlockedBusinessObjectClass() == null) {
                     // if the user didn't specify a class name for the blocked reference, determine it here
                     ibd.setBlockedBusinessObjectClass(DataDictionary
                             .getAttributeClass(getDataObjectClass(), ibd.getBlockedReferencePropertyName()));
                 }
                 ibd.setBlockingReferenceBusinessObjectClass(getBusinessObjectClass());
             }
         }
     }
 
     /**
      * @see java.lang.Object#toString()
      */
     @Override
     public String toString() {
         return "BusinessObjectEntry for " + getBusinessObjectClass();
     }
 }