Package org.kuali.rice.krad.service.impl

Class DataDictionaryServiceImpl

java.lang.Object
org.kuali.rice.krad.service.impl.DataDictionaryServiceImpl
All Implemented Interfaces:
org.kuali.rice.krad.service.DataDictionaryService
public class DataDictionaryServiceImpl extends Object implements org.kuali.rice.krad.service.DataDictionaryService
Service implementation for a DataDictionary. It is a thin wrapper around creating, initializing, and returning a DataDictionary. This is the default, Kuali delivered implementation
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Constructor Details

    • DataDictionaryServiceImpl

      public DataDictionaryServiceImpl()

    • DataDictionaryServiceImpl

      public DataDictionaryServiceImpl(org.kuali.rice.krad.datadictionary.DataDictionary dataDictionary)

  • Method Details

    • setAdditionalDictionaryFiles

      public void setAdditionalDictionaryFiles(Map<String,List<String>> additionalDictionaryFiles) throws IOException
      Specified by:
      setAdditionalDictionaryFiles in interface org.kuali.rice.krad.service.DataDictionaryService
      Throws:
      IOException

    • addDataDictionaryLocations

      public void addDataDictionaryLocations(String namespaceCode, List<String> locations) throws IOException
      Specified by:
      addDataDictionaryLocations in interface org.kuali.rice.krad.service.DataDictionaryService
      Throws:
      IOException

    • getDataDictionary

      public org.kuali.rice.krad.datadictionary.DataDictionary getDataDictionary()
      Specified by:
      getDataDictionary in interface org.kuali.rice.krad.service.DataDictionaryService

    • setDataDictionary

      public void setDataDictionary(org.kuali.rice.krad.datadictionary.DataDictionary dataDictionary)
      Specified by:
      setDataDictionary in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeControlDefinition

      public org.kuali.rice.krad.datadictionary.control.ControlDefinition getAttributeControlDefinition(String entryName, String attributeName)
      Specified by:
      getAttributeControlDefinition in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeSize

      public Integer getAttributeSize(String entryName, String attributeName)
      Specified by:
      getAttributeSize in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeMinLength

      public Integer getAttributeMinLength(String entryName, String attributeName)
      Specified by:
      getAttributeMinLength in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeMaxLength

      public Integer getAttributeMaxLength(String entryName, String attributeName)
      Specified by:
      getAttributeMaxLength in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeExclusiveMin

      public String getAttributeExclusiveMin(String entryName, String attributeName)
      Specified by:
      getAttributeExclusiveMin in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeInclusiveMax

      public String getAttributeInclusiveMax(String entryName, String attributeName)
      Specified by:
      getAttributeInclusiveMax in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeValidatingExpression

      public Pattern getAttributeValidatingExpression(String entryName, String attributeName)
      Specified by:
      getAttributeValidatingExpression in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeLabel

      public String getAttributeLabel(String entryName, String attributeName)
      Specified by:
      getAttributeLabel in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeShortLabel

      public String getAttributeShortLabel(String entryName, String attributeName)
      Specified by:
      getAttributeShortLabel in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeErrorLabel

      public String getAttributeErrorLabel(String entryName, String attributeName)
      Specified by:
      getAttributeErrorLabel in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeFormatter

      public Class<? extends org.kuali.rice.core.web.format.Formatter> getAttributeFormatter(String entryName, String attributeName)
      Specified by:
      getAttributeFormatter in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeForceUppercase

      public Boolean getAttributeForceUppercase(String entryName, String attributeName) throws org.kuali.rice.krad.datadictionary.exception.UnknownBusinessClassAttributeException
      Specified by:
      getAttributeForceUppercase in interface org.kuali.rice.krad.service.DataDictionaryService
      Throws:
      org.kuali.rice.krad.datadictionary.exception.UnknownBusinessClassAttributeException

    • getAttributeSecurity

      public org.kuali.rice.krad.datadictionary.AttributeSecurity getAttributeSecurity(String entryName, String attributeName)
      Specified by:
      getAttributeSecurity in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeSummary

      public String getAttributeSummary(String entryName, String attributeName)
      Specified by:
      getAttributeSummary in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeDescription

      public String getAttributeDescription(String entryName, String attributeName)
      Specified by:
      getAttributeDescription in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • invalid reference 
        org.kuali.rice.krad.service.DataDictionaryService#getAttributeDescription(java.lang.String)

    • isAttributeRequired

      public Boolean isAttributeRequired(String entryName, String attributeName)
      Specified by:
      isAttributeRequired in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.isAttributeRequired(java.lang.Class, java.lang.String)

    • isAttributeDefined

      public Boolean isAttributeDefined(String entryName, String attributeName)
      Specified by:
      isAttributeDefined in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.isAttributeDefined(java.lang.Class, java.lang.String)

    • getAttributeValuesFinderClass

      public Class<? extends org.kuali.rice.krad.keyvalues.KeyValuesFinder> getAttributeValuesFinderClass(String entryName, String attributeName)
      Specified by:
      getAttributeValuesFinderClass in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • invalid reference 
        org.kuali.rice.krad.service.DataDictionaryService#getAttributeValuesScopeId(java.lang.Class, java.lang.String)

    • getCollectionLabel

      public String getCollectionLabel(String entryName, String collectionName)
      Specified by:
      getCollectionLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionLabel(java.lang.Class, java.lang.String)

    • getCollectionShortLabel

      public String getCollectionShortLabel(String entryName, String collectionName)
      Specified by:
      getCollectionShortLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionShortLabel(java.lang.Class, java.lang.String)

    • getCollectionElementLabel

      public String getCollectionElementLabel(String entryName, String collectionName, Class dataObjectClass)
      Specified by:
      getCollectionElementLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • invalid reference 
        org.kuali.rice.krad.service.DataDictionaryService#getCollectionElementLabel(java.lang.Class, java.lang.String)

    • getCollectionSummary

      public String getCollectionSummary(String entryName, String collectionName)
      Specified by:
      getCollectionSummary in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionSummary(java.lang.Class, java.lang.String)

    • getCollectionDescription

      public String getCollectionDescription(String entryName, String collectionName)
      Specified by:
      getCollectionDescription in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionDescription(java.lang.Class, java.lang.String)

    • getRelationshipSourceClass

      public Class<? extends org.kuali.rice.krad.bo.BusinessObject> getRelationshipSourceClass(String entryName, String relationshipName)
      Specified by:
      getRelationshipSourceClass in interface org.kuali.rice.krad.service.DataDictionaryService

    • getRelationshipTargetClass

      public Class<? extends org.kuali.rice.krad.bo.BusinessObject> getRelationshipTargetClass(String entryName, String relationshipName)
      Specified by:
      getRelationshipTargetClass in interface org.kuali.rice.krad.service.DataDictionaryService

    • getRelationshipSourceAttributes

      public List<String> getRelationshipSourceAttributes(String entryName, String relationshipName)
      Specified by:
      getRelationshipSourceAttributes in interface org.kuali.rice.krad.service.DataDictionaryService

    • getRelationshipTargetAttributes

      public List<String> getRelationshipTargetAttributes(String entryName, String relationshipName)
      Specified by:
      getRelationshipTargetAttributes in interface org.kuali.rice.krad.service.DataDictionaryService

    • getRelationshipEntriesForSourceAttribute

      public List<String> getRelationshipEntriesForSourceAttribute(String entryName, String sourceAttributeName)
      Specified by:
      getRelationshipEntriesForSourceAttribute in interface org.kuali.rice.krad.service.DataDictionaryService

    • getRelationshipEntriesForTargetAttribute

      public List<String> getRelationshipEntriesForTargetAttribute(String entryName, String targetAttributeName)
      Specified by:
      getRelationshipEntriesForTargetAttribute in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeDefinition

      public org.kuali.rice.krad.datadictionary.AttributeDefinition getAttributeDefinition(String entryName, String attributeName)
      Specified by:
      getAttributeDefinition in interface org.kuali.rice.krad.service.DataDictionaryService
      Parameters:
      entryName - - the qualified object name e.g. edu.sampleu.demo.kitchensink.TimeInfo
      attributeName - - an attribute name e.g. startTimeAmPm
      Returns:
      AttributeDefinition for the given dataObjectClass and attribute name, or null if there is none
      Throws:
      IllegalArgumentException - if the given Class is null or is not a BusinessObject class

    • getRelationshipAttributeMap

      public Map<String,String> getRelationshipAttributeMap(String entryName, String relationshipName)
      Specified by:
      getRelationshipAttributeMap in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getRelationshipAttributeMap(java.lang.String, java.lang.String)

    • hasRelationship

      public boolean hasRelationship(String entryName, String relationshipName)
      Specified by:
      hasRelationship in interface org.kuali.rice.krad.service.DataDictionaryService

    • getRelationshipNames

      public List<String> getRelationshipNames(String entryName)
      Specified by:
      getRelationshipNames in interface org.kuali.rice.krad.service.DataDictionaryService

    • getAttributeControlDefinition

      public org.kuali.rice.krad.datadictionary.control.ControlDefinition getAttributeControlDefinition(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeControlDefinition in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeControlDefinition(java.lang.String, java.lang.String)

    • getAttributeDescription

      public String getAttributeDescription(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeDescription in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeDescription(java.lang.String, java.lang.String)

    • getAttributeForceUppercase

      public Boolean getAttributeForceUppercase(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeForceUppercase in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeForceUppercase(java.lang.String, java.lang.String)

    • getAttributeFormatter

      public Class<? extends org.kuali.rice.core.web.format.Formatter> getAttributeFormatter(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeFormatter in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeFormatter(java.lang.String, java.lang.String)

    • getAttributeLabel

      public String getAttributeLabel(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeLabel(java.lang.String, java.lang.String)

    • getAttributeMaxLength

      public Integer getAttributeMaxLength(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeMaxLength in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeMaxLength(java.lang.String, java.lang.String)

    • getAttributeShortLabel

      public String getAttributeShortLabel(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeShortLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeShortLabel(java.lang.String, java.lang.String)

    • getAttributeErrorLabel

      public String getAttributeErrorLabel(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeErrorLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeErrorLabel(java.lang.String, java.lang.String)

    • getAttributeSize

      public Integer getAttributeSize(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeSize in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeSize(java.lang.String, java.lang.String)

    • getAttributeSummary

      public String getAttributeSummary(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeSummary in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeSummary(java.lang.String, java.lang.String)

    • getAttributeValidatingExpression

      public Pattern getAttributeValidatingExpression(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeValidatingExpression in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeValidatingExpression(java.lang.String, java.lang.String)

    • getAttributeValuesFinderClass

      public Class getAttributeValuesFinderClass(Class dataObjectClass, String attributeName)
      Specified by:
      getAttributeValuesFinderClass in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeValuesFinderClass(java.lang.String, java.lang.String)

    • getAttributeValidatingErrorMessageKey

      public String getAttributeValidatingErrorMessageKey(String entryName, String attributeName)
      Specified by:
      getAttributeValidatingErrorMessageKey in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeValidatingErrorMessageKey(java.lang.String, java.lang.String)

    • getAttributeValidatingErrorMessageParameters

      public String[] getAttributeValidatingErrorMessageParameters(String entryName, String attributeName)
      Specified by:
      getAttributeValidatingErrorMessageParameters in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAttributeValidatingErrorMessageParameters(java.lang.String, java.lang.String)

    • getCollectionDescription

      public String getCollectionDescription(Class dataObjectClass, String collectionName)
      Specified by:
      getCollectionDescription in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionDescription(java.lang.String, java.lang.String)

    • getCollectionLabel

      public String getCollectionLabel(Class dataObjectClass, String collectionName)
      Specified by:
      getCollectionLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionLabel(java.lang.String, java.lang.String)

    • getCollectionShortLabel

      public String getCollectionShortLabel(Class dataObjectClass, String collectionName)
      Specified by:
      getCollectionShortLabel in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionShortLabel(java.lang.String, java.lang.String)

    • getCollectionSummary

      public String getCollectionSummary(Class dataObjectClass, String collectionName)
      Specified by:
      getCollectionSummary in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getCollectionSummary(java.lang.String, java.lang.String)

    • isAttributeDefined

      public Boolean isAttributeDefined(Class dataObjectClass, String attributeName)
      Specified by:
      isAttributeDefined in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.isAttributeDefined(java.lang.String, java.lang.String)

    • isAttributeRequired

      public Boolean isAttributeRequired(Class dataObjectClass, String attributeName)
      Specified by:
      isAttributeRequired in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.isAttributeRequired(java.lang.String, java.lang.String)

    • getDocumentLabelByClass

      public String getDocumentLabelByClass(Class documentOrBusinessObjectClass)
      Specified by:
      getDocumentLabelByClass in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getDocumentLabelByClass(java.lang.Class)

    • getDocumentLabelByTypeName

      public String getDocumentLabelByTypeName(String documentTypeName)
      Specified by:
      getDocumentLabelByTypeName in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getDocumentLabelByTypeName(java.lang.String)

    • getDocumentTypeNameByClass

      public String getDocumentTypeNameByClass(Class documentClass)
      Specified by:
      getDocumentTypeNameByClass in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getDocumentTypeNameByClass(java.lang.Class)

    • getValidDocumentTypeNameByClass

      public String getValidDocumentTypeNameByClass(Class documentClass)
      Specified by:
      getValidDocumentTypeNameByClass in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getValidDocumentTypeNameByClass(java.lang.Class)

    • getDocumentClassByTypeName

      public Class<? extends org.kuali.rice.krad.document.Document> getDocumentClassByTypeName(String documentTypeName)
      Specified by:
      getDocumentClassByTypeName in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getDocumentClassByTypeName(java.lang.String)

    • getValidDocumentClassByTypeName

      public Class<? extends org.kuali.rice.krad.document.Document> getValidDocumentClassByTypeName(String documentTypeName)
      Specified by:
      getValidDocumentClassByTypeName in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getValidDocumentClassByTypeName(java.lang.String)

    • getViewById

      public org.kuali.rice.krad.uif.view.View getViewById(String viewId)
      Specified by:
      getViewById in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getViewById(java.lang.String)

    • getDictionaryBean

      public Object getDictionaryBean(String id)
      Specified by:
      getDictionaryBean in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getDictionaryBean(java.lang.String)

    • containsDictionaryBean

      public boolean containsDictionaryBean(String id)
      Specified by:
      containsDictionaryBean in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.containsDictionaryBean(java.lang.String)

    • getDictionaryBeanProperty

      public Object getDictionaryBeanProperty(String beanName, String propertyName)
      Specified by:
      getDictionaryBeanProperty in interface org.kuali.rice.krad.service.DataDictionaryService

    • getViewByTypeIndex

      public org.kuali.rice.krad.uif.view.View getViewByTypeIndex(org.kuali.rice.krad.uif.UifConstants.ViewType viewTypeName, Map<String,String> indexKey)
      Specified by:
      getViewByTypeIndex in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • invalid reference 
        org.kuali.rice.krad.service.DataDictionaryService#getViewByTypeIndex(java.lang.String, java.util.Map)

    • getViewIdByTypeIndex

      public String getViewIdByTypeIndex(org.kuali.rice.krad.uif.UifConstants.ViewType viewTypeName, Map<String,String> indexKey)
      Specified by:
      getViewIdByTypeIndex in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getViewIdByTypeIndex(org.kuali.rice.krad.uif.UifConstants.ViewType, java.util.Map<java.lang.String,java.lang.String>)

    • getGroupByAttributesForEffectiveDating

      public List<String> getGroupByAttributesForEffectiveDating(Class dataObjectClass)
      Specified by:
      getGroupByAttributesForEffectiveDating in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getGroupByAttributesForEffectiveDating(java.lang.Class)

    • getAllInactivationBlockingDefinitions

      public Set<org.kuali.rice.krad.datadictionary.InactivationBlockingMetadata> getAllInactivationBlockingDefinitions(Class inactivationBlockedBusinessObjectClass)
      Returns all of the inactivation blocks registered for a particular business object
      Specified by:
      getAllInactivationBlockingDefinitions in interface org.kuali.rice.krad.service.DataDictionaryService
      See Also:
      • DataDictionaryService.getAllInactivationBlockingDefinitions(java.lang.Class)

    • getPropertyEditorMap

      public Map<Class<?>,String> getPropertyEditorMap()
      Specified by:
      getPropertyEditorMap in interface org.kuali.rice.krad.service.DataDictionaryService

    • setPropertyEditorMap

      public void setPropertyEditorMap(Map<Class<?>,String> propertyEditorMap)
      Parameters:
      propertyEditorMap - mapping from property type to property editor
      See Also:

    • getDocumentTypeService

      public org.kuali.rice.kew.api.doctype.DocumentTypeService getDocumentTypeService()

    • setKualiConfigurationService

      public void setKualiConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService)

    • getKualiConfigurationService

      public org.kuali.rice.core.api.config.property.ConfigurationService getKualiConfigurationService()

    • getKualiModuleService

      public org.kuali.rice.krad.service.KualiModuleService getKualiModuleService()

    • setKualiModuleService

      public void setKualiModuleService(org.kuali.rice.krad.service.KualiModuleService kualiModuleService)