Data Dictionary Parent Beans

The are a large number of base beans used by the Data Dictionary. This document lists the basic beans used and their properties and purpose.

Documentation Extraction Note

These are the beans defined by the Rice KNS. Some of these beans may have been overridden within KFS.

Bean Summary

Bean Name	Implementation Class	Purpose
Top Level Beans
#BusinessObjectEntry	org.kuali.kfs.sys.businessobject.datadictionary.FinancialSystemBusinessObjectEntry	A single BusinessObject entry in the DataDictionary, which contains information relating to the display, validation, and general maintenance of a BusinessObject and its attributes. You must define one of these for each BusinessObject that you want to render in the user interface.
#MaintenanceDocumentEntry TODO	org.kuali.kfs.sys.document.datadictionary.FinancialSystemMaintenanceDocumentEntry
#TransactionalDocumentEntry TODO	org.kuali.kfs.sys.document.datadictionary.FinancialSystemTransactionalDocumentEntry
Business Object Support Beans
#AttributeDefinition	org.kuali.kfs.krad.datadictionary.AttributeDefinition	These are the attributes of a business object or transactional document. Each instance represents a single property on the underlying java class identified by the businessObjectClass or documentClass property.
#InquiryDefinition	org.kuali.kfs.krad.datadictionary.InquiryDefinition
#LookupDefinition	org.kuali.kfs.krad.datadictionary.LookupDefinition
#FieldDefinition	org.kuali.kfs.krad.datadictionary.FieldDefinition
#RelationshipDefinition	org.kuali.kfs.krad.datadictionary.RelationshipDefinition	Used to define a relationship between this business object/document and another business object. These are usually only needed when the relationship has not been defined at the database mapping layer.
#ReferenceDefinition	org.kuali.kfs.krad.datadictionary.ReferenceDefinition
#PrimitiveAttributeDefinition	org.kuali.kfs.krad.datadictionary.PrimitiveAttributeDefinition	Used within a RelationshipDefinition to define an attributes that makes up the foreign key relationship with the other class.
#SupportAttributeDefinition	org.kuali.kfs.krad.datadictionary.SupportAttributeDefinition
Maintenance Document Support Beans
#MaintainableFieldDefinition	org.kuali.kfs.kns.datadictionary.MaintainableFieldDefinition
#MaintainableSectionDefinition	org.kuali.kfs.kns.datadictionary.MaintainableSectionDefinition
#MaintainableSubSectionHeaderDefinition	org.kuali.kfs.kns.datadictionary.MaintainableSubSectionHeaderDefinition
#MaintainableCollectionDefinition	org.kuali.kfs.kns.datadictionary.MaintainableCollectionDefinition
Other Document Support Beans
#WorkflowProperties	org.kuali.kfs.krad.datadictionary.WorkflowProperties
Control Definition Beans
CheckboxControlDefinition	org.kuali.kfs.kns.datadictionary.control.CheckboxControlDefinition
TextControlDefinition	org.kuali.kfs.kns.datadictionary.control.TextControlDefinition
RadioControlDefinition	org.kuali.kfs.kns.datadictionary.control.RadioControlDefinition
FileControlDefinition	org.kuali.kfs.kns.datadictionary.control.FileControlDefinition
Validator Beans
PhoneNumberValidationPattern	org.kuali.kfs.kns.datadictionary.validation.fieldlevel.PhoneNumberValidationPattern
NumericValidationPattern	org.kuali.kfs.kns.datadictionary.validation.charlevel.NumericValidationPattern
AnyCharacterValidationPattern	org.kuali.kfs.kns.datadictionary.validation.charlevel.AnyCharacterValidationPattern
UTF8AnyCharacterValidationPattern	org.kuali.kfs.kns.datadictionary.validation.charlevel.UTF8AnyCharacterValidationPattern

Bean Detail

BusinessObjectEntry

Also see: Business Objects

Property	Type	Required	Default	Purpose
businessObjectClass	Class	Y		The business object class which this `BusinessObjectEntry` definition represents.
attributes	List<#AttributeDefinition>	Y		List of attributes defined for this business object. Each entry is an `AttributeDefinition` which defines the properties for a single property on this business object.
relationships	List<#RelationshipDefinition>	N		Relationships between this and other business objects which are not mapped at the database mapping level.
inquiryDefinition	#InquiryDefinition	N	null	See related section
lookupDefinition	#LookupDefinition	N	null	See related section
titleAttribute	String	Y		Note use for drilldown from lookup.
objectLabel	String			Unsure where used - collections?
objectDescription	String	N		only used for no-longer-used help text
boNotesEnabled	boolean	N	false	Whether this BO can accept attached note records.
helpDefinition	#HelpDefinition	N	null	Defines the system parameter to get the URL for the help for this business object. Not Currently used.

AttributeDefinition

Property	Type	Required	Default	Purpose
name	String	Y		The name of the property on the enclosing business object.
label	String	Y		Label to display when this attribute is presented in the UI.
shortLabel	String	N	(value of label)
displayLabelAttribute	String	N	null	Indicates that the label values should be taken from another attribute on this object.
maxLength	Integer	N	null	The maxLength element determines the maximum size of the field for data entry edit purposes.
exclusiveMin	BigDecimal	N	null	The minimum allowable value for data entry editing purposes. Value can be an integer or decimal value such as -.001 or 99.
inclusiveMax	BigDecimal	N	null	The maximum allowable value for data entry editing purposes. Value can be an integer or decimal value such as -.001 or 99.
validationPattern	#ValidationPattern	N		Defines the allowable character-level or field-level values for an attribute.
required	Boolean	Y	false
control	#ControlDefinition	Y		Defines the manner in which an attribute is displayed and the manner in which the attribute value is entered.
displayWorkgroup	String	N		Specifies the name of a workgroup. Only users in this workgroup will be able to view the un-masked value.
displayMask	#Mask TODO	N		Specifies the type of masking to be used to hide the value from un-authorized users.
summary	String	N		Not presently used
description	String	N		Not presently used
formatterClass	Class<? extends #Formatter TODO>	N	null	Used when custom formatting is required for display of the field value. This field specifies the name of the java class to be used for the formatting.

Bean Definition XML

<!--
   - The Kuali Financial System, a comprehensive financial management system for higher education.
   - 
   - Copyright 2005-2015 The Kuali Foundation
   - 
   - This program is free software: you can redistribute it and/or modify
   - it under the terms of the GNU Affero General Public License as
   - published by the Free Software Foundation, either version 3 of the
   - License, or (at your option) any later version.
   - 
   - This program is distributed in the hope that it will be useful,
   - but WITHOUT ANY WARRANTY; without even the implied warranty of
   - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   - GNU Affero General Public License for more details.
   - 
   - You should have received a copy of the GNU Affero General Public License
   - along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
   xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">

   <bean id="FloatingPointValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.FloatingPointValidationPattern"
      abstract="true" />

    <bean id="ZipcodeValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.ZipcodeValidationPattern"
      abstract="true" />
   <bean id="EmailAddressValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.EmailAddressValidationPattern"
      abstract="true" />
   <bean id="InquiryCollectionDefinition"
      class="org.kuali.kfs.kns.datadictionary.InquiryCollectionDefinition"
      abstract="true" />
   <bean id="MaskFormatter" class="org.kuali.kfs.krad.datadictionary.mask.MaskFormatter"
      abstract="true" />
   <bean id="LookupHiddenControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.LookupHiddenControlDefinition"
      abstract="true" />
   <bean id="CheckboxControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.CheckboxControlDefinition"
      abstract="true" />
   <bean id="TextControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.TextControlDefinition"
      abstract="true" />
   <bean id="FileControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.FileControlDefinition"
      abstract="true" />
   <bean id="RadioControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.RadioControlDefinition"
      abstract="true" />
   <bean id="PhoneNumberValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.PhoneNumberValidationPattern"
      abstract="true" />

   <bean id="JavaClassValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.JavaClassValidationPattern"
      abstract="true" />
   <bean id="NumericValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.charlevel.NumericValidationPattern"
      abstract="true" />

   <bean id="InquirySectionDefinition"
      class="org.kuali.kfs.kns.datadictionary.InquirySectionDefinition"
      abstract="true" />
   <bean id="HeaderNavigation" class="org.kuali.kfs.kns.datadictionary.HeaderNavigation"
      abstract="true" />

   <bean id="HiddenControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.HiddenControlDefinition"
      abstract="true" />
   <bean id="MonthValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.MonthValidationPattern"
      abstract="true" />

   <bean id="LookupReadonlyControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.LookupReadonlyControlDefinition"
      abstract="true" />

   <bean id="CharsetValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.charlevel.CharsetValidationPattern"
      abstract="true" />

   <bean id="DateValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.DateValidationPattern"
      abstract="true" />
   <bean id="FieldDefinition" class="org.kuali.kfs.kns.datadictionary.FieldDefinition"
      abstract="true" />
   <bean id="MaintainableCollectionDefinition"
      class="org.kuali.kfs.kns.datadictionary.MaintainableCollectionDefinition"
      abstract="true" />
   <bean id="AnyCharacterValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.charlevel.AnyCharacterValidationPattern"
      abstract="true" />
  <bean id="UTF8AnyCharacterValidationPattern"
        class="org.kuali.kfs.kns.datadictionary.validation.charlevel.UTF8AnyCharacterValidationPattern"
        abstract="true" />
   <bean id="InquirySubSectionHeaderDefinition"
      class="org.kuali.kfs.kns.datadictionary.InquirySubSectionHeaderDefinition"
      abstract="true" />

   <bean id="CurrencyControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.CurrencyControlDefinition"
      abstract="true" />
   <bean id="YearValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.YearValidationPattern"
      abstract="true" />

   <bean id="TimestampValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.TimestampValidationPattern"
      abstract="true" />
   <bean id="FixedPointValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.fieldlevel.FixedPointValidationPattern"
      abstract="true" />
   <bean id="InquiryDefinition" class="org.kuali.kfs.kns.datadictionary.InquiryDefinition"
      abstract="true" />
   <bean id="TextareaControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.TextareaControlDefinition"
      abstract="true" />
   <bean id="KualiUserControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.KualiUserControlDefinition"
      abstract="true" />
   <bean id="AlphaNumericValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.charlevel.AlphaNumericValidationPattern"
      abstract="true" />
   <bean id="MaintainableFieldDefinition"
      class="org.kuali.kfs.kns.datadictionary.MaintainableFieldDefinition"
      abstract="true" />
   <bean id="AlphaValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.charlevel.AlphaValidationPattern"
      abstract="true" />

   <bean id="LookupDefinition" class="org.kuali.kfs.kns.datadictionary.LookupDefinition"
      abstract="true" />
   <bean id="WorkflowWorkgroupControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.WorkflowWorkgroupControlDefinition"
      abstract="true" />
   <bean id="MaintainableSubSectionHeaderDefinition"
      class="org.kuali.kfs.kns.datadictionary.MaintainableSubSectionHeaderDefinition"
      abstract="true" />

    <bean id="SelectControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.SelectControlDefinition"
      abstract="true" />
   <bean id="MultiselectControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.MultiselectControlDefinition"
      abstract="true" />
   <bean id="MaintainableSectionDefinition"
      class="org.kuali.kfs.kns.datadictionary.MaintainableSectionDefinition"
      abstract="true" />
   <bean id="RegexValidationPattern"
      class="org.kuali.kfs.kns.datadictionary.validation.charlevel.RegexValidationPattern"
      abstract="true" />

   <bean id="ButtonControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.ButtonControlDefinition"
      abstract="true" />
   <bean id="LinkControlDefinition"
      class="org.kuali.kfs.kns.datadictionary.control.LinkControlDefinition"
      abstract="true" />

   <bean id="TransactionalDocumentEntry"
      class="org.kuali.kfs.kns.datadictionary.TransactionalDocumentEntry"
      abstract="true" />

   <bean id="BusinessObjectEntry" class="org.kuali.kfs.kns.datadictionary.BusinessObjectEntry"
      abstract="true" />

   <bean id="MaintenanceDocumentEntry"
      class="org.kuali.kfs.kns.datadictionary.MaintenanceDocumentEntry"
      abstract="true">
        <property name="maintainableClass" value="org.kuali.kfs.kns.maintenance.KualiMaintainableImpl"/>
        <property name="dataObjectClass" value="org.kuali.kfs.kns.document.MaintenanceDocumentBase"/>
        <property name="businessRulesClass" value="org.kuali.kfs.kns.maintenance.rules.MaintenanceDocumentRuleBase"/>
     </bean>

</beans>