Package org.kuali.rice.kns.datadictionary

Class MaintainableFieldDefinition

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
org.kuali.rice.kns.datadictionary.MaintainableItemDefinition
org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition
All Implemented Interfaces:
Serializable, Cloneable, FieldDefinitionI, org.kuali.rice.krad.datadictionary.Copyable, org.kuali.rice.krad.datadictionary.DataDictionaryDefinition, org.kuali.rice.krad.datadictionary.DictionaryBean
@Deprecated public class MaintainableFieldDefinition extends MaintainableItemDefinition implements FieldDefinitionI
Deprecated.
Use Field subclasses.
The maintainableField element defines the specifications for one data field. JSTL: maintainableField is a Map accessed by the field name. It contains entries with the following keys: * field (boolean String) * name (String) * required (boolean String) name is the name of the field required is true if the field must contain a non-null value readOnly is true if it cannot be updated template documentation from MaintenanceUtils.java: Field templates are used in relation to multiple value lookups. When doing a MV lookup on a collection, the returned BOs are not necessarily of the same type as the elements of the collection. Therefore, a means of mapping between the fields for the 2 BOs are necessary. The template attribute of <maintainableField> contained within <maintainableCollection> tells us this mapping. Example: <maintainableField name="collectionAttrib" template="lookupBOAttrib"> means that when a list of BOs are returned, the lookupBOAttrib value of the looked up BO will be placed into the collectionAttrib value of the BO added to the collection webUILeaveFieldFunction - The name of a javascript function to called when when the user tabs out of the field. webUILeaveFieldCallbackFunction - This is the call javascript function related to the webUILeaveFieldFunction. readOnlyAfterAdd - This is used to indicate that the field is read-only after the record has been initially created.
See Also:

  • Field Details

    • required

      protected boolean required
      Deprecated.

    • unconditionallyReadOnly

      protected boolean unconditionallyReadOnly
      Deprecated.

    • readOnlyAfterAdd

      protected boolean readOnlyAfterAdd
      Deprecated.

    • noLookup

      protected boolean noLookup
      Deprecated.

    • lookupReadOnly

      protected boolean lookupReadOnly
      Deprecated.

    • defaultValue

      protected String defaultValue
      Deprecated.

    • template

      protected String template
      Deprecated.

    • defaultValueFinderClass

      protected Class<? extends org.kuali.rice.krad.valuefinder.ValueFinder> defaultValueFinderClass
      Deprecated.

    • webUILeaveFieldFunction

      protected String webUILeaveFieldFunction
      Deprecated.

    • webUILeaveFieldCallbackFunction

      protected String webUILeaveFieldCallbackFunction
      Deprecated.

    • webUILeaveFieldFunctionParameters

      protected List<String> webUILeaveFieldFunctionParameters
      Deprecated.

    • overrideLookupClass

      protected Class<? extends org.kuali.rice.krad.bo.BusinessObject> overrideLookupClass
      Deprecated.

    • overrideFieldConversions

      protected String overrideFieldConversions
      Deprecated.

    • alternateDisplayAttributeName

      protected String alternateDisplayAttributeName
      Deprecated.

    • additionalDisplayAttributeName

      protected String additionalDisplayAttributeName
      Deprecated.

    • triggerOnChange

      protected boolean triggerOnChange
      Deprecated.

    • showFieldLevelHelp

      protected Boolean showFieldLevelHelp
      Deprecated.

    • fieldLevelHelpUrl

      protected String fieldLevelHelpUrl
      Deprecated.

  • Constructor Details

    • MaintainableFieldDefinition

      public MaintainableFieldDefinition()
      Deprecated.

  • Method Details

    • isRequired

      public boolean isRequired()
      Deprecated.
      Returns:
      true if this attribute is required

    • setRequired

      public void setRequired(boolean required)
      Deprecated.
      required is true if the field must contain a non-null value

    • getDefaultValue

      public String getDefaultValue()
      Deprecated.
      Returns:
      Returns the defaultValue.

    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      Deprecated.
      The defaultValue element will pre-load the specified value into the lookup field.

    • getDefaultValueFinderClass

      public Class<? extends org.kuali.rice.krad.valuefinder.ValueFinder> getDefaultValueFinderClass()
      Deprecated.
      Returns:
      custom defaultValue class

    • isUnconditionallyReadOnly

      public boolean isUnconditionallyReadOnly()
      Deprecated.
      Returns:
      the unconditionallyReadOnly

    • setUnconditionallyReadOnly

      public void setUnconditionallyReadOnly(boolean unconditionallyReadOnly)
      Deprecated.
      Parameters:
      unconditionallyReadOnly - the unconditionallyReadOnly to set

    • getOverrideFieldConversions

      public String getOverrideFieldConversions()
      Deprecated.
      Gets the overrideFieldConversions attribute.
      Returns:
      Returns the overrideFieldConversions.

    • setOverrideFieldConversions

      public void setOverrideFieldConversions(String overrideFieldConversions)
      Deprecated.
      Single value lookups expect field conversions to be passed in as a HTTP parameter when the lookups is invoked from a quickfinder icon (i.e. magnifying glass on page). Field conversions are normally used to determine which fields will be returned when the "return value" link is clicked. For example, if we're performing a quickfinder lookup and the field conversion string "a:document.someObject.a1,b:document.someObject.b1" is passed into the lookup, this means that when we click on a lookup result row to be returned: the value of property "a" from the selected result bo will be passed as the value of the HTTP parameter named "document.someObject.a1", which, in turn, populates the POJO property of the same name on the form the value of property "b" from the selected result bo will be passed as the value of the HTTP parameter named "document.someObject.b1", which, in turn, populates the POJO property of the same name on the form Normally, the field conversion string is automatically computed by the framework to return all of the primary key values of the looked up BO into the corresponding foreign key values of the destination BO (i.e. document.someObject in the example above). However, putting in this element will allow for the overriding of the field conversions string.

    • getOverrideLookupClass

      public Class<? extends org.kuali.rice.krad.bo.BusinessObject> getOverrideLookupClass()
      Deprecated.
      Gets the overrideLookupClass attribute.
      Returns:
      Returns the overrideLookupClass.

    • completeValidation

      public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass)
      Deprecated.
      Directly validate simple fields.
      Specified by:
      completeValidation in interface org.kuali.rice.krad.datadictionary.DataDictionaryDefinition
      Overrides:
      completeValidation in class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
      See Also:
      • invalid reference 
        org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class MaintainableItemDefinition
      See Also:

    • getTemplate

      public String getTemplate()
      Deprecated.

    • setTemplate

      public void setTemplate(String template)
      Deprecated.
      template documentation from MaintenanceUtils.java: Field templates are used in relation to multiple value lookups. When doing a MV lookup on a collection, the returned BOs are not necessarily of the same type as the elements of the collection. Therefore, a means of mapping between the fields for the 2 BOs are necessary. The template attribute of <maintainableField> contained within <maintainableCollection> tells us this mapping. Example: <maintainableField name="collectionAttrib" template="lookupBOAttrib"> means that when a list of BOs are returned, the lookupBOAttrib value of the looked up BO will be placed into the collectionAttrib value of the BO added to the collection

    • getWebUILeaveFieldCallbackFunction

      public String getWebUILeaveFieldCallbackFunction()
      Deprecated.

    • setWebUILeaveFieldCallbackFunction

      public void setWebUILeaveFieldCallbackFunction(String webUILeaveFieldCallbackFunction)
      Deprecated.
      webUILeaveFieldCallbackFunction This is the call javascript function related to the webUILeaveFieldFunction.

    • getWebUILeaveFieldFunction

      public String getWebUILeaveFieldFunction()
      Deprecated.

    • setWebUILeaveFieldFunction

      public void setWebUILeaveFieldFunction(String webUILeaveFieldFunction)
      Deprecated.
      webUILeaveFieldFunction is the name of a javascript function to called when when the user tabs out of the field.

    • isReadOnlyAfterAdd

      public boolean isReadOnlyAfterAdd()
      Deprecated.
      Specified by:
      isReadOnlyAfterAdd in interface FieldDefinitionI

    • setReadOnlyAfterAdd

      public void setReadOnlyAfterAdd(boolean readOnlyAfterAdd)
      Deprecated.
      This is used to indicate that the field is read-only after the record has been initially created.

    • setDefaultValueFinderClass

      public void setDefaultValueFinderClass(Class<? extends org.kuali.rice.krad.valuefinder.ValueFinder> defaultValueFinderClass)
      Deprecated.
      The defaultValueFinderClass specifies the java class that will be used to determine the default value of a lookup field. The classname specified in this field must implement ValueFinder

    • setOverrideLookupClass

      public void setOverrideLookupClass(Class<? extends org.kuali.rice.krad.bo.BusinessObject> overrideLookupClass)
      Deprecated.
      The overrideLookupClass element is used to indicate the class that should be used for the magnifying glass lookup. The specified class must be a subclass of the business object class.

    • isNoLookup

      public boolean isNoLookup()
      Deprecated.
      Returns:
      the noLookup

    • setNoLookup

      public void setNoLookup(boolean noLookup)
      Deprecated.
      Parameters:
      noLookup - the noLookup to set

    • isLookupReadOnly

      public boolean isLookupReadOnly()
      Deprecated.

    • setLookupReadOnly

      public void setLookupReadOnly(boolean lookupReadOnly)
      Deprecated.

    • isShowFieldLevelHelp

      public Boolean isShowFieldLevelHelp()
      Deprecated.

    • setShowFieldLevelHelp

      public void setShowFieldLevelHelp(Boolean showFieldLevelHelp)
      Deprecated.

    • getFieldLevelHelpUrl

      public String getFieldLevelHelpUrl()
      Deprecated.

    • setFieldLevelHelpUrl

      public void setFieldLevelHelpUrl(String fieldLevelHelpUrl)
      Deprecated.

    • getAlternateDisplayAttributeName

      public String getAlternateDisplayAttributeName()
      Deprecated.
      The alternateDisplayAttributeName is the name of the attribute whose value will be displayed instead of the actual maintenance field attribute. Only applies when field is read-only.
      Specified by:
      getAlternateDisplayAttributeName in interface FieldDefinitionI

    • setAlternateDisplayAttributeName

      public void setAlternateDisplayAttributeName(String alternateDisplayAttributeName)
      Deprecated.

    • getAdditionalDisplayAttributeName

      public String getAdditionalDisplayAttributeName()
      Deprecated.
      The additionalDisplayAttributeName is the name of the attribute whose value will be displayed in addition to the actual maintenance field attribute. Only applies when field is read-only.
      Specified by:
      getAdditionalDisplayAttributeName in interface FieldDefinitionI

    • setAdditionalDisplayAttributeName

      public void setAdditionalDisplayAttributeName(String additionalDisplayAttributeName)
      Deprecated.

    • isTriggerOnChange

      public boolean isTriggerOnChange()
      Deprecated.

    • setTriggerOnChange

      public void setTriggerOnChange(boolean triggerOnChange)
      Deprecated.

    • getWebUILeaveFieldFunctionParameters

      public List<String> getWebUILeaveFieldFunctionParameters()
      Deprecated.
      Returns:
      the webUILeaveFieldFunctionParameters

    • setWebUILeaveFieldFunctionParameters

      public void setWebUILeaveFieldFunctionParameters(List<String> webUILeaveFieldFunctionParameters)
      Deprecated.
      Parameters:
      webUILeaveFieldFunctionParameters - the webUILeaveFieldFunctionParameters to set