/*

  * Copyright 2005-2007 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.kns.service.impl;

 import java.beans.IndexedPropertyDescriptor;

 import java.beans.PropertyDescriptor;

 import java.lang.reflect.InvocationTargetException;

 import java.util.ArrayList;

 import java.util.Collection;

 import java.util.HashSet;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Set;

 import org.apache.commons.beanutils.PropertyUtils;

 import org.apache.commons.lang.StringUtils;

 import org.apache.log4j.Logger;

 import org.kuali.rice.kew.exception.WorkflowException;

 import org.kuali.rice.kns.bo.BusinessObject;

 import org.kuali.rice.kns.bo.PersistableBusinessObject;

 import org.kuali.rice.kns.datadictionary.BusinessObjectEntry;

 import org.kuali.rice.kns.datadictionary.FieldDefinition;

 import org.kuali.rice.kns.datadictionary.InquiryDefinition;

 import org.kuali.rice.kns.datadictionary.InquirySectionDefinition;

 import org.kuali.rice.kns.datadictionary.LookupDefinition;

 import org.kuali.rice.kns.datadictionary.MaintenanceDocumentEntry;

 import org.kuali.rice.kns.exception.IntrospectionException;

 import org.kuali.rice.kns.inquiry.InquiryAuthorizer;

 import org.kuali.rice.kns.inquiry.InquiryAuthorizerBase;

 import org.kuali.rice.kns.inquiry.InquiryPresentationController;

 import org.kuali.rice.kns.inquiry.InquiryPresentationControllerBase;

 import org.kuali.rice.kns.lookup.valuefinder.ValueFinder;

 import org.kuali.rice.kns.service.*;

 import org.kuali.rice.kns.util.ObjectUtils;

 /**

  * This class is the service implementation for the BusinessObjectDictionary.

  * This is the default, Kuali delivered implementation which leverages the

  * DataDictionaryService.

  */

 public class BusinessObjectDictionaryServiceImpl implements

                 BusinessObjectDictionaryService {

         private static Logger LOG = Logger

                         .getLogger(BusinessObjectDictionaryServiceImpl.class);

     private DataDictionaryService dataDictionaryService;

     private PersistenceStructureService persistenceStructureService;

         public <T extends BusinessObject> InquiryAuthorizer getInquiryAuthorizer(

                         Class<T> businessObjectClass) {

                 Class inquiryAuthorizerClass = getDataDictionaryService()

                                 .getDataDictionary().getBusinessObjectEntry(

                                                 businessObjectClass.getName()).getInquiryDefinition()

                                 .getAuthorizerClass();

                 if (inquiryAuthorizerClass == null) {

                         inquiryAuthorizerClass = InquiryAuthorizerBase.class;

                 }

                 try {

                         return (InquiryAuthorizer) inquiryAuthorizerClass.newInstance();

                 } catch (Exception e) {

                         throw new RuntimeException(

                                         "Unable to instantiate InquiryAuthorizer class: "

                                                         + inquiryAuthorizerClass, e);

                 }

         }

         public <T extends BusinessObject> InquiryPresentationController getInquiryPresentationController(

                         Class<T> businessObjectClass) {

                 Class inquiryPresentationControllerClass = getDataDictionaryService()

                                 .getDataDictionary().getBusinessObjectEntry(

                                                 businessObjectClass.getName()).getInquiryDefinition()

                                 .getPresentationControllerClass();

                 if (inquiryPresentationControllerClass == null) {

                         inquiryPresentationControllerClass = InquiryPresentationControllerBase.class;

                 }

                 try {

                         return (InquiryPresentationController) inquiryPresentationControllerClass

                                         .newInstance();

                 } catch (Exception e) {

                         throw new RuntimeException(

                                         "Unable to instantiate InquiryPresentationController class: "

                                                         + inquiryPresentationControllerClass, e);

                 }

         }

     /**

      * Uses the DataDictionaryService.

      *

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getBusinessObjectEntries()

      */

     public List getBusinessObjectClassnames() {

                 return getDataDictionaryService().getDataDictionary()

                                 .getBusinessObjectClassNames();

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#isLookupable(java.lang.Class)

      */

     public Boolean isLookupable(Class businessObjectClass) {

         Boolean isLookupable = Boolean.FALSE;

         BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

             isLookupable = Boolean.valueOf(entry.hasLookupDefinition());

         }

         return isLookupable;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#isInquirable(java.lang.Class)

      */

     public Boolean isInquirable(Class businessObjectClass) {

         Boolean isInquirable = Boolean.FALSE;

         BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

             isInquirable = Boolean.valueOf(entry.hasInquiryDefinition());

         }

         return isInquirable;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#isMaintainable(java.lang.Class)

      */

     public Boolean isMaintainable(Class businessObjectClass) {

         Boolean isMaintainable = Boolean.FALSE;

         BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

                         isMaintainable = Boolean

                                         .valueOf(getMaintenanceDocumentEntry(businessObjectClass) != null);

         }

         return isMaintainable;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#isExportable(java.lang.Class)

          */

         public Boolean isExportable(Class businessObjectClass) {

                 Boolean isExportable = Boolean.FALSE;

                 BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

             isExportable = entry.getExporterClass() != null;

         }

         return isExportable;

         }

         /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupFieldNames(java.lang.Class)

      */

     public List getLookupFieldNames(Class businessObjectClass) {

         List results = null;

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             results = lookupDefinition.getLookupFieldNames();

         }

         return results;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupTitle(java.lang.Class)

      */

     public String getLookupTitle(Class businessObjectClass) {

         String lookupTitle = "";

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             lookupTitle = lookupDefinition.getTitle();

         }

         return lookupTitle;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupMenuBar(java.lang.Class)

      */

     public String getLookupMenuBar(Class businessObjectClass) {

         String menubar = "";

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             if (lookupDefinition.hasMenubar()) {

                 menubar = lookupDefinition.getMenubar();

             }

         }

         return menubar;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getExtraButtonSource(java.lang.Class)

      */

     public String getExtraButtonSource(Class businessObjectClass) {

         String buttonSource = "";

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             if (lookupDefinition.hasExtraButtonSource()) {

                 buttonSource = lookupDefinition.getExtraButtonSource();

             }

         }

         return buttonSource;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getExtraButtonParams(java.lang.Class)

      */

     public String getExtraButtonParams(Class businessObjectClass) {

         String buttonParams = "";

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             if (lookupDefinition.hasExtraButtonParams()) {

                 buttonParams = lookupDefinition.getExtraButtonParams();

             }

         }

         return buttonParams;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getSearchIconOverride(java.lang.Class)

      */

     public String getSearchIconOverride(Class businessObjectClass) {

         String iconUrl = "";

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             if (lookupDefinition.hasSearchIconOverride()) {

                 iconUrl = lookupDefinition.getSearchIconOverride();

             }

         }

         return iconUrl;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupDefaultSortFieldName(java.lang.Class)

      */

     public List getLookupDefaultSortFieldNames(Class businessObjectClass) {

         List defaultSort = null;

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             if (lookupDefinition.hasDefaultSort()) {

                                 defaultSort = lookupDefinition.getDefaultSort()

                                                 .getAttributeNames();

             }

         }

         if (defaultSort == null) {

             defaultSort = new ArrayList();

         }

         return defaultSort;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupResultFieldNames(java.lang.Class)

      */

     public List<String> getLookupResultFieldNames(Class businessObjectClass) {

         List<String> results = null;

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             results = lookupDefinition.getResultFieldNames();

         }

         return results;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupResultFieldMaxLength(java.lang.Class,

          *      java.lang.String)

      */

         public Integer getLookupResultFieldMaxLength(Class businessObjectClass,

                         String resultFieldName) {

                 Integer resultFieldMaxLength = null;

                 LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

                 if (lookupDefinition != null) {

                         FieldDefinition field = lookupDefinition.getResultField(resultFieldName);

                         if (field != null) {

                                 resultFieldMaxLength = field.getMaxLength();

                         }

                 }

                 return resultFieldMaxLength;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupResultSetLimit(java.lang.Class)

      */

     public Integer getLookupResultSetLimit(Class businessObjectClass) {

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if ( lookupDefinition != null ) {

                         return lookupDefinition.getResultSetLimit(); // TODO: stupid, change

                                                                                                                         // to return int

         } else {

             return null;

         }

     }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupNumberOfColumns(java.lang.Class)

          */

         public Integer getLookupNumberOfColumns(Class businessObjectClass) {

                 // default to 1

                 int numberOfColumns = 1;

                 LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

                 if (lookupDefinition != null) {

                         if (lookupDefinition.getNumOfColumns() > 1) {

                                 numberOfColumns = lookupDefinition.getNumOfColumns();

                         }

                 }

                 return numberOfColumns;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupAttributeRequired(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean getLookupAttributeRequired(Class businessObjectClass,

                         String attributeName) {

         Boolean isRequired = null;

                 FieldDefinition definition = getLookupFieldDefinition(

                                 businessObjectClass, attributeName);

         if (definition != null) {

             isRequired = Boolean.valueOf(definition.isRequired());

         }

         return isRequired;

     }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupAttributeReadOnly(java.lang.Class,

          *      java.lang.String)

          */

         public Boolean getLookupAttributeReadOnly(Class businessObjectClass, String attributeName) {

                 Boolean readOnly = null;

                 FieldDefinition definition = getLookupFieldDefinition(businessObjectClass, attributeName);

                 if (definition != null) {

                         readOnly = Boolean.valueOf(definition.isReadOnly());

                 }

                 return readOnly;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getInquiryFieldNames(java.lang.Class,

          *      java.lang.String)

      */

         public List getInquiryFieldNames(Class businessObjectClass,

                         String sectionTitle) {

         List results = null;

                 InquirySectionDefinition inquirySection = getInquiryDefinition(

                                 businessObjectClass).getInquirySection(sectionTitle);

         if (inquirySection != null) {

             results = inquirySection.getInquiryFieldNames();

         }

         return results;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getInquirySections(java.lang.Class)

      */

     public List<InquirySectionDefinition> getInquirySections(Class businessObjectClass) {

         List<InquirySectionDefinition> results = null;

                 results = getInquiryDefinition(businessObjectClass)

                                 .getInquirySections();

         return results;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getInquiryTitle(java.lang.Class)

      */

     public String getInquiryTitle(Class businessObjectClass) {

         String title = "";

         InquiryDefinition inquiryDefinition = getInquiryDefinition(businessObjectClass);

         if (inquiryDefinition != null) {

             title = inquiryDefinition.getTitle();

         }

         return title;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getInquirableClass(java.lang.Class)

      */

     public Class getInquirableClass(Class businessObjectClass) {

         Class clazz = null;

         InquiryDefinition inquiryDefinition = getInquiryDefinition(businessObjectClass);

         if (inquiryDefinition != null) {

             clazz = inquiryDefinition.getInquirableClass();

         }

         return clazz;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getMaintainableTitle(java.lang.Class)

      */

     public String getMaintainableLabel(Class businessObjectClass) {

         String label = "";

         try {

             MaintenanceDocumentEntry entry = getMaintenanceDocumentEntry(businessObjectClass);

             if (entry != null) {

                 label = KNSServiceLocatorWeb.getWorkflowInfoService().getDocType(entry.getDocumentTypeName()).getDocTypeLabel();

             }

         } catch (WorkflowException e) {

             throw new RuntimeException("Caught Exception trying to get the document type", e);

         }

         return label;

     }

     /**

      *

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupableID(java.lang.Class)

      */

     public String getLookupableID(Class businessObjectClass) {

         String lookupableID = null;

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             lookupableID = lookupDefinition.getLookupableID();

         }

         return lookupableID;

     }

     /**

          * Recurses down the updatable references and collections of a BO,

          * uppercasing those attributes which are marked as needing to be uppercased

          * in the data dictionary. Updatability of a reference or collection is

          * defined by the PersistenceStructureService

      *

          * @param bo

          *            the BO to uppercase

      *

      * @see PersistenceStructureService#isCollectionUpdatable(Class, String)

      * @see PersistenceStructureService#isReferenceUpdatable(Class, String)

      * @see DataDictionaryService#getAttributeForceUppercase(Class, String)

      */

     public void performForceUppercase(BusinessObject bo) {

             performForceUppercaseCycleSafe(bo, new HashSet<BusinessObject>());

     }

     /**

      * Handles recursion for performForceUppercase in a cycle-safe manner,

      * keeping track of visited BusinessObjects to prevent infinite recursion.

      */

     protected void performForceUppercaseCycleSafe(BusinessObject bo, Set<BusinessObject> visited) {

             if (visited.contains(bo)) {

                     return;

             } else {

                     visited.add(bo);

             }

                 PropertyDescriptor descriptors[] = PropertyUtils

                                 .getPropertyDescriptors(bo);

         for (int i = 0; i < descriptors.length; ++i) {

             try {

                 if (descriptors[i] instanceof IndexedPropertyDescriptor) {

                                         // Skip this case because PropertyUtils.getProperty(bo,

                                         // descriptors[i].getName()) will throw a

                     // NoSuchMethodException on those. These

                                         // fields are usually convenience methods in the BO and in

                                         // the below code we anyway wouldn't know which index

                     // .toUpperCase().

                                 } else {

                                         Object nestedObject = ObjectUtils.getPropertyValue(bo,

                                                         descriptors[i].getName());

                                         if (ObjectUtils.isNotNull(nestedObject)

                                                         && nestedObject instanceof BusinessObject) {

                                                 if (persistenceStructureService

                                                                 .isPersistable(nestedObject.getClass())) {

                                 try {

                                                                 if (persistenceStructureService.hasReference(bo

                                                                                 .getClass(), descriptors[i].getName())) {

                                                                         if (persistenceStructureService

                                                                                         .isReferenceUpdatable(

                                                                                                         bo.getClass(),

                                                                                                         descriptors[i].getName())) {

                                                                                 if (persistenceStructureService

                                                                                                 .getForeignKeyFieldsPopulationState(

                                                                                                                 (PersistableBusinessObject) bo,

                                                                                                                 descriptors[i]

                                                                                                                                 .getName())

                                                                                                 .isAllFieldsPopulated()) {

                                                                                         // check FKs to prevent probs caused

                                                                                         // by referential integrity problems

                                             performForceUppercaseCycleSafe((BusinessObject) nestedObject, visited);

                                     }

                                     }

                                 }

                                 } catch (org.kuali.rice.kns.exception.ReferenceAttributeNotAnOjbReferenceException ranaore) {

                                                                 LOG.debug("Propery " + descriptors[i].getName()

                                                                                 + " is not a foreign key reference.");

                                 }

                             }

                     } else if (nestedObject instanceof String) {

                                                 if (dataDictionaryService.isAttributeDefined(

                                                                 bo.getClass(), descriptors[i].getName())

                                                                 .booleanValue()

                                                                 && dataDictionaryService

                                                                                 .getAttributeForceUppercase(

                                                                                                 bo.getClass(),

                                                                                                 descriptors[i].getName())

                                                                                 .booleanValue()) {

                             String curValue = (String) nestedObject;

                                                         PropertyUtils.setProperty(bo, descriptors[i]

                                                                         .getName(), curValue.toUpperCase());

                         }

                                         } else {

                                                 if (ObjectUtils.isNotNull(nestedObject)

                                                                 && nestedObject instanceof Collection) {

                                                         if (persistenceStructureService.hasCollection(bo

                                                                         .getClass(), descriptors[i].getName())) {

                                                                 if (persistenceStructureService

                                                                                 .isCollectionUpdatable(bo.getClass(),

                                                                                                 descriptors[i].getName())) {

                                                                         Iterator iter = ((Collection) nestedObject)

                                                                                         .iterator();

                             while (iter.hasNext()) {

                                 Object collElem = iter.next();

                                 if (collElem instanceof BusinessObject) {

                                                                                         if (persistenceStructureService

                                                                                                         .isPersistable(collElem

                                                                                                                         .getClass())) {

                                                 performForceUppercaseCycleSafe((BusinessObject) collElem, visited);

                                             }

                                         }

                                     }

                                 }

                             }

                         }

                     }

                 }

                         } catch (IllegalAccessException e) {

                                 throw new IntrospectionException(

                                                 "unable to performForceUppercase", e);

                         } catch (InvocationTargetException e) {

                                 throw new IntrospectionException(

                                                 "unable to performForceUppercase", e);

                         } catch (NoSuchMethodException e) {

                 // if the getter/setter does not exist, just skip over

                                 // throw new

                                 // IntrospectionException("unable to performForceUppercase", e);

             }

         }

     }

     /**

      * Sets the instance of the data dictionary service.

      *

      * @param dataDictionaryService

      */

         public void setDataDictionaryService(

                         DataDictionaryService dataDictionaryService) {

         this.dataDictionaryService = dataDictionaryService;

     }

     /**

      * This method retrieves the instance of the data dictionary service.

      *

      * @return An instance of the DataDictionaryService.

      */

     public DataDictionaryService getDataDictionaryService() {

         return this.dataDictionaryService;

     }

     /**

      * @param businessObjectClass

          * @return BusinessObjectEntry for the given businessObjectClass, or null if

          *         there is none

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

     private BusinessObjectEntry getBusinessObjectEntry(Class businessObjectClass) {

         validateBusinessObjectClass(businessObjectClass);

                 BusinessObjectEntry entry = getDataDictionaryService()

                                 .getDataDictionary().getBusinessObjectEntry(

                                                 businessObjectClass.getName());

         return entry;

     }

     /**

      * @param businessObjectClass

          * @return MaintenanceDocumentEntry for the given businessObjectClass, or

          *         null if there is none

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

         private MaintenanceDocumentEntry getMaintenanceDocumentEntry(

                         Class businessObjectClass) {

         validateBusinessObjectClass(businessObjectClass);

                 MaintenanceDocumentEntry entry = getDataDictionaryService()

                                 .getDataDictionary()

                                 .getMaintenanceDocumentEntryForBusinessObjectClass(

                                                 businessObjectClass);

         return entry;

     }

     /**

      * @param businessObjectClass

          * @return LookupDefinition for the given businessObjectClass, or null if

          *         there is none

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

     private LookupDefinition getLookupDefinition(Class businessObjectClass) {

         LookupDefinition lookupDefinition = null;

         BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

             if (entry.hasLookupDefinition()) {

                 lookupDefinition = entry.getLookupDefinition();

             }

         }

         return lookupDefinition;

     }

     /**

      * @param businessObjectClass

      * @param attributeName

          * @return FieldDefinition for the given businessObjectClass and lookup

          *         field name, or null if there is none

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

         private FieldDefinition getLookupFieldDefinition(Class businessObjectClass,

                         String lookupFieldName) {

         if (StringUtils.isBlank(lookupFieldName)) {

                         throw new IllegalArgumentException(

                                         "invalid (blank) lookupFieldName");

         }

         FieldDefinition fieldDefinition = null;

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             fieldDefinition = lookupDefinition.getLookupField(lookupFieldName);

         }

         return fieldDefinition;

     }

     /**

      * @param businessObjectClass

      * @param attributeName

          * @return FieldDefinition for the given businessObjectClass and lookup

          *         result field name, or null if there is none

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

         private FieldDefinition getLookupResultFieldDefinition(

                         Class businessObjectClass, String lookupFieldName) {

         if (StringUtils.isBlank(lookupFieldName)) {

                         throw new IllegalArgumentException(

                                         "invalid (blank) lookupFieldName");

         }

         FieldDefinition fieldDefinition = null;

         LookupDefinition lookupDefinition = getLookupDefinition(businessObjectClass);

         if (lookupDefinition != null) {

             fieldDefinition = lookupDefinition.getResultField(lookupFieldName);

         }

         return fieldDefinition;

     }

     /**

      * @param businessObjectClass

          * @return InquiryDefinition for the given businessObjectClass, or null if

          *         there is none

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

     private InquiryDefinition getInquiryDefinition(Class businessObjectClass) {

         InquiryDefinition inquiryDefinition = null;

         BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

             if (entry.hasInquiryDefinition()) {

                 inquiryDefinition = entry.getInquiryDefinition();

             }

         }

         return inquiryDefinition;

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getTitleAttribute(java.lang.Class)

      */

     public String getTitleAttribute(Class businessObjectClass) {

         String titleAttribute = null;

         BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

             titleAttribute = entry.getTitleAttribute();

         }

         return titleAttribute;

     }

     /**

      * @param businessObjectClass

      * @param attributeName

          * @return FieldDefinition for the given businessObjectClass and field name,

          *         or null if there is none

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

         private FieldDefinition getInquiryFieldDefinition(

                         Class businessObjectClass, String fieldName) {

         if (StringUtils.isBlank(fieldName)) {

             throw new IllegalArgumentException("invalid (blank) fieldName");

         }

         FieldDefinition fieldDefinition = null;

         InquiryDefinition inquiryDefinition = getInquiryDefinition(businessObjectClass);

         if (inquiryDefinition != null) {

             fieldDefinition = inquiryDefinition.getFieldDefinition(fieldName);

         }

         return fieldDefinition;

     }

     /**

      * @param businessObjectClass

          * @throws IllegalArgumentException

          *             if the given Class is null or is not a BusinessObject class

      */

     private void validateBusinessObjectClass(Class businessObjectClass) {

         if (businessObjectClass == null) {

                         throw new IllegalArgumentException(

                                         "invalid (null) businessObjectClass");

         }

         if (!BusinessObject.class.isAssignableFrom(businessObjectClass)) {

                         throw new IllegalArgumentException("class '"

                                         + businessObjectClass.getName()

                                         + "' is not a descendent of BusinessObject");

         }

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#forceLookupResultFieldInquiry(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean forceLookupResultFieldInquiry(Class businessObjectClass,

                         String attributeName) {

         Boolean forceLookup = null;

         if (getLookupResultFieldDefinition(businessObjectClass, attributeName) != null) {

                         forceLookup = Boolean.valueOf(getLookupResultFieldDefinition(

                                         businessObjectClass, attributeName).isForceInquiry());

         }

         return forceLookup;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#noLookupResultFieldInquiry(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean noLookupResultFieldInquiry(Class businessObjectClass,

                         String attributeName) {

         Boolean noLookup = null;

         if (getLookupResultFieldDefinition(businessObjectClass, attributeName) != null) {

                         noLookup = Boolean.valueOf(getLookupResultFieldDefinition(

                                         businessObjectClass, attributeName).isNoInquiry());

         }

         return noLookup;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#forceLookupFieldLookup(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean forceLookupFieldLookup(Class businessObjectClass,

                         String attributeName) {

         Boolean forceLookup = null;

         if (getLookupFieldDefinition(businessObjectClass, attributeName) != null) {

                         forceLookup = Boolean.valueOf(getLookupFieldDefinition(

                                         businessObjectClass, attributeName).isForceLookup());

         }

         return forceLookup;

     }

         public Boolean forceInquiryFieldLookup(Class businessObjectClass,

                         String attributeName) {

         Boolean forceInquiry = null;

         if (getLookupFieldDefinition(businessObjectClass, attributeName) != null) {

                         forceInquiry = Boolean.valueOf(getLookupFieldDefinition(

                                         businessObjectClass, attributeName).isForceInquiry());

         }

         return forceInquiry;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#noLookupFieldLookup(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean noLookupFieldLookup(Class businessObjectClass,

                         String attributeName) {

         Boolean noLookup = null;

         if (getLookupFieldDefinition(businessObjectClass, attributeName) != null) {

                         noLookup = Boolean.valueOf(getLookupFieldDefinition(

                                         businessObjectClass, attributeName).isNoLookup());

         }

         return noLookup;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#noLookupFieldLookup(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean noDirectInquiryFieldLookup(Class businessObjectClass,

                         String attributeName) {

         Boolean noDirectInquiry = null;

         if (getLookupFieldDefinition(businessObjectClass, attributeName) != null) {

                         noDirectInquiry = Boolean.valueOf(getLookupFieldDefinition(

                                         businessObjectClass, attributeName).isNoDirectInquiry());

         }

         return noDirectInquiry;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupResultFieldUseShortLabel(java.lang.Class,

          *      java.lang.String)

          */

         public Boolean getLookupResultFieldUseShortLabel(Class businessObjectClass,

                         String attributeName) {

         Boolean useShortLabel = null;

         if (getLookupResultFieldDefinition(businessObjectClass, attributeName) != null) {

                         useShortLabel = Boolean.valueOf(getLookupResultFieldDefinition(

                                         businessObjectClass, attributeName).isUseShortLabel());

         }

         return useShortLabel;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupResultFieldTotal(java.lang.Class,

          *      java.lang.String)

          */

         public Boolean getLookupResultFieldTotal(Class businessObjectClass, String attributeName) {

                 Boolean total = false;

                 if (getLookupResultFieldDefinition(businessObjectClass, attributeName) != null) {

                         total = Boolean.valueOf(getLookupResultFieldDefinition(

                                         businessObjectClass, attributeName).isTotal());

                 }

                 return total;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#forceInquiryFieldInquiry(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean forceInquiryFieldInquiry(Class businessObjectClass,

                         String attributeName) {

         Boolean forceInquiry = null;

         if (getInquiryFieldDefinition(businessObjectClass, attributeName) != null) {

                         forceInquiry = Boolean.valueOf(getInquiryFieldDefinition(

                                         businessObjectClass, attributeName).isForceInquiry());

         }

         return forceInquiry;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#noInquiryFieldInquiry(java.lang.Class,

          *      java.lang.String)

      */

         public Boolean noInquiryFieldInquiry(Class businessObjectClass,

                         String attributeName) {

         Boolean noInquiry = null;

         if (getInquiryFieldDefinition(businessObjectClass, attributeName) != null) {

                         noInquiry = Boolean.valueOf(getInquiryFieldDefinition(

                                         businessObjectClass, attributeName).isNoInquiry());

         }

         return noInquiry;

     }

     /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupFieldDefaultValue(java.lang.Class,

          *      java.lang.String)

      */

         public String getLookupFieldDefaultValue(Class businessObjectClass,

                         String attributeName) {

                 return getLookupFieldDefinition(businessObjectClass, attributeName)

                                 .getDefaultValue();

     }

     /**

      * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupFieldDefaultValueFinderClass(java.lang.Class,

      *      java.lang.String)

      */

         public Class<? extends ValueFinder> getLookupFieldDefaultValueFinderClass(

                         Class businessObjectClass, String attributeName) {

                 return getLookupFieldDefinition(businessObjectClass, attributeName)

                                 .getDefaultValueFinderClass();

     }

         /** {@inheritDoc} */

         public String getLookupFieldQuickfinderParameterString(Class businessObjectClass, String attributeName) {

                 return getLookupFieldDefinition(businessObjectClass, attributeName).getQuickfinderParameterString();

         }

         /** {@inheritDoc} */

         public Class<? extends ValueFinder> getLookupFieldQuickfinderParameterStringBuilderClass(Class businessObjectClass, String attributeName) {

                 return getLookupFieldDefinition(businessObjectClass, attributeName).getQuickfinderParameterStringBuilderClass();

         }

         public void setPersistenceStructureService(

                         PersistenceStructureService persistenceStructureService) {

         this.persistenceStructureService = persistenceStructureService;

     }

     public Boolean areNotesSupported(Class businessObjectClass) {

         Boolean hasNotesSupport = Boolean.FALSE;

         BusinessObjectEntry entry = getBusinessObjectEntry(businessObjectClass);

         if (entry != null) {

             hasNotesSupport = entry.isBoNotesEnabled();

         }

         return hasNotesSupport;

     }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#isLookupFieldTreatWildcardsAndOperatorsAsLiteral(java.lang.Class, java.lang.String)

          */

         public boolean isLookupFieldTreatWildcardsAndOperatorsAsLiteral(Class businessObjectClass, String attributeName) {

                 FieldDefinition lookupFieldDefinition = getLookupFieldDefinition(businessObjectClass, attributeName);

                 return lookupFieldDefinition != null && lookupFieldDefinition.isTreatWildcardsAndOperatorsAsLiteral();

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getInquiryFieldAdditionalDisplayAttributeName(java.lang.Class,

          *      java.lang.String)

          */

         public String getInquiryFieldAdditionalDisplayAttributeName(Class businessObjectClass, String attributeName) {

                 String additionalDisplayAttributeName = null;

                 if (getInquiryFieldDefinition(businessObjectClass, attributeName) != null) {

                         additionalDisplayAttributeName = getInquiryFieldDefinition(businessObjectClass, attributeName)

                                         .getAdditionalDisplayAttributeName();

                 }

                 return additionalDisplayAttributeName;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getInquiryFieldAlternateDisplayAttributeName(java.lang.Class,

          *      java.lang.String)

          */

         public String getInquiryFieldAlternateDisplayAttributeName(Class businessObjectClass, String attributeName) {

                 String alternateDisplayAttributeName = null;

                 if (getInquiryFieldDefinition(businessObjectClass, attributeName) != null) {

                         alternateDisplayAttributeName = getInquiryFieldDefinition(businessObjectClass, attributeName)

                                         .getAlternateDisplayAttributeName();

                 }

                 return alternateDisplayAttributeName;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupFieldAdditionalDisplayAttributeName(java.lang.Class,

          *      java.lang.String)

          */

         public String getLookupFieldAdditionalDisplayAttributeName(Class businessObjectClass, String attributeName) {

                 String additionalDisplayAttributeName = null;

                 if (getLookupResultFieldDefinition(businessObjectClass, attributeName) != null) {

                         additionalDisplayAttributeName = getLookupResultFieldDefinition(businessObjectClass, attributeName)

                                         .getAdditionalDisplayAttributeName();

                 }

                 return additionalDisplayAttributeName;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getLookupFieldAlternateDisplayAttributeName(java.lang.Class,

          *      java.lang.String)

          */

         public String getLookupFieldAlternateDisplayAttributeName(Class businessObjectClass, String attributeName) {

                 String alternateDisplayAttributeName = null;

                 if (getLookupResultFieldDefinition(businessObjectClass, attributeName) != null) {

                         alternateDisplayAttributeName = getLookupResultFieldDefinition(businessObjectClass, attributeName)

                                         .getAlternateDisplayAttributeName();

                 }

                 return alternateDisplayAttributeName;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#tranlateCodesInLookup(java.lang.Class)

          */

         public Boolean tranlateCodesInLookup(Class businessObjectClass) {

                 boolean translateCodes = false;

                 if (getLookupDefinition(businessObjectClass) != null) {

                         translateCodes = getLookupDefinition(businessObjectClass).isTranslateCodes();

                 }

                 return translateCodes;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#tranlateCodesInInquiry(java.lang.Class)

          */

         public Boolean tranlateCodesInInquiry(Class businessObjectClass) {

                 boolean translateCodes = false;

                 if (getInquiryDefinition(businessObjectClass) != null) {

                         translateCodes = getInquiryDefinition(businessObjectClass).isTranslateCodes();

                 }

                 return translateCodes;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#isLookupFieldTriggerOnChange(java.lang.Class,

          *      java.lang.String)

          */

         public boolean isLookupFieldTriggerOnChange(Class businessObjectClass, String attributeName) {

                 boolean triggerOnChange = false;

                 if (getLookupFieldDefinition(businessObjectClass, attributeName) != null) {

                         triggerOnChange = getLookupFieldDefinition(businessObjectClass, attributeName).isTriggerOnChange();

                 }

                 return triggerOnChange;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#disableSearchButtonsInLookup(java.lang.Class)

          */

         public boolean disableSearchButtonsInLookup(Class businessObjectClass) {

                 boolean disableSearchButtons = false;

                 if (getLookupDefinition(businessObjectClass) != null) {

                         disableSearchButtons = getLookupDefinition(businessObjectClass).isDisableSearchButtons();

                 }

                 return disableSearchButtons;

         }

         /**

          * @see org.kuali.rice.kns.service.BusinessObjectDictionaryService#getGroupByAttributesForEffectiveDating(java.lang.Class)

          */

         public List<String> getGroupByAttributesForEffectiveDating(Class businessObjectClass) {

                 List<String> groupByList = null;

                 if (getBusinessObjectEntry(businessObjectClass) != null) {

                         groupByList = getBusinessObjectEntry(businessObjectClass).getGroupByAttributesForEffectiveDating();

                 }

                 return groupByList;

         }

 }