Package io.jmix.aitools.dataload.introspection.model

Interface EntityPropertyDescriptor

All Known Implementing Classes:
AbstractEntityPropertyDescriptor, DatatypePropertyDescriptor, EmbeddedPropertyDescriptor, EnumPropertyDescriptor, RelationPropertyDescriptor
public interface EntityPropertyDescriptor
Read-only description of a single entity property, exposed for domain-model discovery.

  • Method Details

    • getName

      String getName()
      Returns the property name.
      Returns:
      property name

    • getLocalizedNames

      List<String> getLocalizedNames()
      Returns the property captions for the configured locales.
      Returns:
      localized property names

    • getJavaType

      String getJavaType()
      Returns the simple Java type name of the property.
      Returns:
      Java type name

    • getPropertyType

      String getPropertyType()
      Returns the Jmix property type (for example "datatype" or "enum").
      Returns:
      property type name

    • getIdentifier

      @Nullable Boolean getIdentifier()
      Returns whether the property is the entity identifier.
      Returns:
      true if the property is the primary key, or null otherwise

    • getPersistent

      Boolean getPersistent()
      Returns whether the property is persistent (stored in the database).
      Returns:
      true if the property is persistent

    • getMandatory

      Boolean getMandatory()
      Returns whether the property is mandatory.
      Returns:
      true if the property is mandatory

    • getComment

      @Nullable String getComment()
      Returns the property comment.
      Returns:
      comment text, or null if none