Package org.kuali.rice.kns.datadictionary

Class FieldDefinition

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
org.kuali.rice.kns.datadictionary.FieldDefinition
All Implemented Interfaces:
Serializable, Cloneable, FieldDefinitionI, org.kuali.rice.krad.datadictionary.Copyable, org.kuali.rice.krad.datadictionary.DataDictionaryDefinition, org.kuali.rice.krad.datadictionary.DictionaryBean
Direct Known Subclasses:
InquiryCollectionDefinition, InquirySubSectionHeaderDefinition
@Deprecated public class FieldDefinition extends org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase implements FieldDefinitionI
Deprecated.
Use Field subclasses.
Contains field-related information for DataDictionary entries. Used by lookups and inquiries. Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process.
See Also:

  • Field Details

    • attributeName

      protected String attributeName
      Deprecated.

    • required

      protected boolean required
      Deprecated.

    • forceInquiry

      protected boolean forceInquiry
      Deprecated.

    • noInquiry

      protected boolean noInquiry
      Deprecated.

    • noDirectInquiry

      protected boolean noDirectInquiry
      Deprecated.

    • forceLookup

      protected boolean forceLookup
      Deprecated.

    • noLookup

      protected boolean noLookup
      Deprecated.

    • useShortLabel

      protected boolean useShortLabel
      Deprecated.

    • defaultValue

      protected String defaultValue
      Deprecated.

    • defaultValueFinderClass

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

    • quickfinderParameterString

      protected String quickfinderParameterString
      Deprecated.

    • quickfinderParameterStringBuilderClass

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

    • maxLength

      protected Integer maxLength
      Deprecated.

    • displayEditMode

      protected String displayEditMode
      Deprecated.

    • displayMask

      protected org.kuali.rice.krad.datadictionary.mask.Mask displayMask
      Deprecated.

    • hidden

      protected boolean hidden
      Deprecated.

    • readOnly

      protected boolean readOnly
      Deprecated.

    • treatWildcardsAndOperatorsAsLiteral

      protected boolean treatWildcardsAndOperatorsAsLiteral
      Deprecated.

    • alternateDisplayAttributeName

      protected String alternateDisplayAttributeName
      Deprecated.

    • additionalDisplayAttributeName

      protected String additionalDisplayAttributeName
      Deprecated.

    • triggerOnChange

      protected boolean triggerOnChange
      Deprecated.

    • total

      protected boolean total
      Deprecated.

  • Constructor Details

    • FieldDefinition

      public FieldDefinition()
      Deprecated.

  • Method Details

    • getAttributeName

      public String getAttributeName()
      Deprecated.
      Returns:
      attributeName

    • setAttributeName

      public void setAttributeName(String attributeName)
      Deprecated.
      Sets attributeName to the given value.
      Parameters:
      attributeName -
      Throws:
      IllegalArgumentException - if the given attributeName is blank

    • isRequired

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

    • setRequired

      public void setRequired(boolean required)
      Deprecated.
      required = true means that the user must enter something into the search criterion lookup field

    • isForceInquiry

      public boolean isForceInquiry()
      Deprecated.
      Returns:
      Returns the forceInquiry.

    • setForceInquiry

      public void setForceInquiry(boolean forceInquiry)
      Deprecated.
      forceInquiry = true means that the displayed field value will always be made inquirable (this attribute is not used within the code).

    • isForceLookup

      public boolean isForceLookup()
      Deprecated.
      Returns:
      Returns the forceLookup.

    • setForceLookup

      public void setForceLookup(boolean forceLookup)
      Deprecated.
      forceLookup = this attribute is not used

    • isNoInquiry

      public boolean isNoInquiry()
      Deprecated.
      Returns:
      Returns the noInquiry.

    • isNoDirectInquiry

      public boolean isNoDirectInquiry()
      Deprecated.
      Returns:
      Returns a boolean value indicating whether or not to provide a direct inquiry for the lookup field

    • setNoInquiry

      public void setNoInquiry(boolean noInquiry)
      Deprecated.
      noInquiry = true means that the displayed field will never be made inquirable.

    • setNoDirectInquiry

      public void setNoDirectInquiry(boolean noDirectInquiry)
      Deprecated.
      Parameters:
      noInquiry - If true, the displayed field will not have a direct inquiry facility

    • isNoLookup

      public boolean isNoLookup()
      Deprecated.
      Returns:
      Returns the noLookup.

    • setNoLookup

      public void setNoLookup(boolean noLookup)
      Deprecated.
      noLookup = true means that field should not include magnifying glass (i.e. quickfinder)

    • isUseShortLabel

      public boolean isUseShortLabel()
      Deprecated.
      Returns:
      the useShortLabel

    • setUseShortLabel

      public void setUseShortLabel(boolean useShortLabel)
      Deprecated.
      Parameters:
      useShortLabel - the useShortLabel to set

    • 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 field.

    • getQuickfinderParameterString

      public String getQuickfinderParameterString()
      Deprecated.
      the quickfinderParameterString is a comma separated list of parameter/value pairs, of the format "param1=value1,param2=value2", where the parameters correspond to attributes of the target class for the quickfinder, and the values to literals that those attributes will default to when the quickfinder is used.
      Returns:
      the quickfinderParameterString

    • setQuickfinderParameterString

      public void setQuickfinderParameterString(String quickfinderParameterString)
      Deprecated.
      Parameters:
      quickfinderParameterString - the quickfinderParameterString to set. See getQuickfinderParameterString()

    • getQuickfinderParameterStringBuilderClass

      public Class<? extends org.kuali.rice.krad.valuefinder.ValueFinder> getQuickfinderParameterStringBuilderClass()
      Deprecated.
      the quickfinderParameterStringBuilderClass specifies the java class that will be used to determine the default value(s) for field(s) on the target lookup when the quickfinder is used. The classname specified in this field must implement ValueFinder. See getQuickfinderParameterString() for the result string format.
      Returns:
      the quickfinderParameterStringBuilderClass

    • setQuickfinderParameterStringBuilderClass

      public void setQuickfinderParameterStringBuilderClass(Class<? extends org.kuali.rice.krad.valuefinder.ValueFinder> quickfinderParameterStringBuilderClass)
      Deprecated.
      See getQuickfinderParameterStringBuilderClass()
      Parameters:
      quickfinderParameterStringBuilderClass - the quickfinderParameterStringBuilderClass to set

    • 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 Object
      See Also:

    • getName

      public String getName()
      Deprecated.
      Specified by:
      getName in interface FieldDefinitionI

    • getDisplayEditMode

      public String getDisplayEditMode()
      Deprecated.

    • setDisplayEditMode

      public void setDisplayEditMode(String displayEditMode)
      Deprecated.

    • getDisplayMask

      public org.kuali.rice.krad.datadictionary.mask.Mask getDisplayMask()
      Deprecated.

    • setDisplayMask

      public void setDisplayMask(org.kuali.rice.krad.datadictionary.mask.Mask displayMask)
      Deprecated.
      The displayMask element specifies the type of masking to be used to hide the value from un-authorized users. There are three types of masking.

    • isReadOnlyAfterAdd

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

    • getMaxLength

      public Integer getMaxLength()
      Deprecated.
      Gets the maxLength attribute.
      Returns:
      Returns the maxLength.

    • setMaxLength

      public void setMaxLength(Integer maxLength)
      Deprecated.
      maxLength = the maximum allowable length of the field in the lookup result fields. In other contexts, like inquiries, this field has no effect.

    • getDefaultValueFinderClass

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

    • 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 field. The classname specified in this field must implement ValueFinder

    • isHidden

      public boolean isHidden()
      Deprecated.
      Returns:
      the hidden

    • setHidden

      public void setHidden(boolean hidden)
      Deprecated.
      Parameters:
      hidden - If the ControlDefinition.isHidden == true then a corresponding LookupDefinition would automatically be removed from the search criteria. In some cases you might want the hidden field to be used as a search criteria. For example, in PersonImpl.xml a client might want to have the campus code hidden and preset to Bloomington. So when the search is run, only people from the bloomington campus are returned. So, if you want to have a hidden search criteria, set this variable to true. Defaults to false.

    • isReadOnly

      public boolean isReadOnly()
      Deprecated.
      Returns:
      the readOnly

    • setReadOnly

      public void setReadOnly(boolean readOnly)
      Deprecated.
      Parameters:
      readOnly - the readOnly to set

    • isTriggerOnChange

      public boolean isTriggerOnChange()
      Deprecated.

    • setTriggerOnChange

      public void setTriggerOnChange(boolean triggerOnChange)
      Deprecated.

    • isTreatWildcardsAndOperatorsAsLiteral

      public boolean isTreatWildcardsAndOperatorsAsLiteral()
      Deprecated.
      Returns:
      the treatWildcardsAndOperatorsAsLiteralOnLookups

    • setTreatWildcardsAndOperatorsAsLiteral

      public void setTreatWildcardsAndOperatorsAsLiteral(boolean treatWildcardsAndOperatorsAsLiteralOnLookups)
      Deprecated.
      Parameters:
      treatWildcardsAndOperatorsAsLiteralOnLookups - the treatWildcardsAndOperatorsAsLiteralOnLookups to set

    • getAlternateDisplayAttributeName

      public String getAlternateDisplayAttributeName()
      Deprecated.
      Specified by:
      getAlternateDisplayAttributeName in interface FieldDefinitionI

    • setAlternateDisplayAttributeName

      public void setAlternateDisplayAttributeName(String alternateDisplayAttributeName)
      Deprecated.

    • getAdditionalDisplayAttributeName

      public String getAdditionalDisplayAttributeName()
      Deprecated.
      Specified by:
      getAdditionalDisplayAttributeName in interface FieldDefinitionI

    • setAdditionalDisplayAttributeName

      public void setAdditionalDisplayAttributeName(String additionalDisplayAttributeName)
      Deprecated.

    • isTotal

      public boolean isTotal()
      Deprecated.

    • setTotal

      public void setTotal(boolean total)
      Deprecated.