Package com.sap.cds.reflect

Interface CdsElementDefinition

All Superinterfaces:
CdsAnnotatable, CdsNamed
All Known Subinterfaces:
CdsElement
public interface CdsElementDefinition extends CdsAnnotatable, CdsNamed

  • Method Details

    • getName

      String getName()
      Returns the name of this CdsElement.
      Returns:
      the namespace of this element, not null

    • getType

      <T extends CdsType> T getType()
      Returns the type of this CdsElement.
      Type Parameters:
      T - the CdsType of this element
      Returns:
      the type of this element, not null

    • isKey

      boolean isKey()
      Returns true if this CdsElement is a key.
      Returns:
      true if this element is a key, otherwise false

    • isVirtual

      boolean isVirtual()
      Returns true if this CdsElement is virtual.
      Returns:
      true if this is a virtual element, otherwise false

    • isUnique

      boolean isUnique()
      Returns true if this CdsElement is unique.
      Returns:
      true if this is a unique element, otherwise false

    • isNotNull

      boolean isNotNull()
      Returns true if this CdsElement cannot be null.
      Returns:
      true if this element cannot be null, otherwise false

    • isLocalized

      boolean isLocalized()
      Returns true if this CdsElement is localized.
      Returns:
      true if this element is localized, otherwise false

    • defaultValue

      Optional<Object> defaultValue()
      Returns an Optional wrapping the default value of this element.
      Returns:
      an Optional describing the default value of this element, or an empty Optional if there is no default value

    • getKey

      default String getKey()
      Description copied from interface: CdsNamed
      Returns the name that uniquely identifies this named object
      Specified by:
      getKey in interface CdsNamed
      Returns:
      the identifying name

    • getExpression

      default Optional<CqnValue> getExpression()
      Returns the expression that calculates this element.
      Returns:
      the reference to an CqnValue that defines value of the element

    • isCalculated

      default boolean isCalculated()
      Returns true if this CdsElement is calculated.
      Returns:
      true if this element is calculated, otherwise false