Package org.kuali.rice.krad.data.metadata

Interface DataObjectAttribute

All Superinterfaces:
MetadataCommon, Serializable
All Known Subinterfaces:
DataObjectAttributeInternal
All Known Implementing Classes:
DataObjectAttributeImpl
public interface DataObjectAttribute extends MetadataCommon
Attribute metadata

Represents attribute metadata (persistent or non-persistent) for a data object.

Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getOwningType

      Class<?> getOwningType()
      Gets the data object type

      Gets the data object type to which this attribute belongs.

      Returns:
      class type

    • getDisplayAttributeName

      String getDisplayAttributeName()
      Gets the display attribute name.

      To be used on attributes which have an associated business key that is shown to users rather than the "internal" key which is likely a meaningless (to the users) sequence number.

      Returns:
      user friendly business key

    • getMaxLength

      Long getMaxLength()
      Gets the maximum length.

      The maximum length value which will be accepted into this field.

      Returns:
      maximum length

    • getMinLength

      Long getMinLength()
      Gets the minimum length.

      The minimum length value which will be accepted into this field.

      Returns:
      minimum length

    • isCaseInsensitive

      boolean isCaseInsensitive()
      Determines if attribute is case insensitive.

      Whether this attribute should be treated as case insensitive when performing lookups and searches.

      Returns:
      attribute case insensitive

    • isForceUppercase

      boolean isForceUppercase()
      Determines if attribute should be forced to upper case.

      Whether this attribute should be forced to upper case before being sent to the PersistenceProvider.

      Returns:
      attribute forced upper case

    • isRequired

      boolean isRequired()
      Determines if attribute is required.

      Whether (at the data level) this attribute must have a non-null value.

      Returns:
      attribute is required

    • getValidCharactersConstraintBeanName

      @Beta String getValidCharactersConstraintBeanName()
      BETA: Gets the bean name.

      The bean name (in the UIF data dictionary), which checks the entered value's characters for correctness.

      Returns:
      bean name

    • getPropertyEditor

      PropertyEditor getPropertyEditor()
      Gets the property editor.

      To be used by the persistence layer when loading and persisting the data. (E.g., strip extra characters from phone numbers to leave only the digits for storage in the database.).

      Returns:
      property editor

    • isSensitive

      boolean isSensitive()
      Determines attribute case insensitivity.

      Whether this attribute is protected at the persistence level and should be protected by default when included on user interfaces.

      Returns:
      attribute case insensitivity

    • getValidValues

      KeyValuesFinder getValidValues()
      Gets the values if a drop-down.

      If this field should be rendered using a drop-down list, specify the instance on this property.

      Returns:
      drop-down values

    • getDataType

      DataType getDataType()
      Gets the derived krad data type.

      The derived krad-data data type used by the UIF to help generate the appropriate control and perform default validation.

      Returns:
      derived keard data type

    • isPersisted

      boolean isPersisted()
      Determines whether data object is persistent.

      Whether or not this attribute of the data object is saved to persistent storage when saved via the DataObjectService.

      Returns:
      whether data object is persistent

    • getInheritedFromType

      Class<?> getInheritedFromType()
      Gets class type object is inherited from.

      If this attribute is inherited from a different data object, that object's type. Otherwise null.

      Returns:
      class type inherited from

    • getInheritedFromAttributeName

      String getInheritedFromAttributeName()
      Gets inherited attribute name.

      If this attribute is inherited from a different data object, the source attribute name. Otherwise null.

      Returns:
      inherited attribute name

    • getInheritedFromParentAttributeName

      String getInheritedFromParentAttributeName()
      Gets inherited parent attribute name.

      If this attribute is inherited from a different data object, the attribute name on the parent object. Otherwise null.

      Returns:
      inherited parent attribute name

    • isInherited

      boolean isInherited()
      Determines whether attribute is inherited.

      Whether this attribute is inherited from a different data object.

      Returns:
      whether attribute is inherited

    • getOriginalDataObjectAttribute

      DataObjectAttribute getOriginalDataObjectAttribute()
      Gets original data object.

      Obtains the "original" data object attribute in a chain of embedded attribute definitions.

      Returns:
      original data object