Package overit.geocall.edm.model

Interface DataAttribute

All Superinterfaces:
BaseDataAttribute, Serializable
All Known Implementing Classes:
ExtendedDataAttributeImpl
public interface DataAttribute extends BaseDataAttribute
Interface about an extended data attribute in the Entity-Data-Model (EDM).

  • Method Details

    • getLabel

      String getLabel()
      Retrieves the label of the data attribute.
      Returns:
      The label of the attribute.

    • getAliasFor

      String getAliasFor()
      Retrieves the name of the field for which this attribute is an alias.
      Returns:
      the name of the field for which this attribute is an alias.

    • canView

      boolean canView(Identity identity)
      Checks if the specified identity has permission to view the attribute.
      Parameters:
      identity - The identity to check permissions for.
      Returns:
      true if the identity can view the attribute, false otherwise.

    • canEdit

      boolean canEdit(Identity identity)
      Checks if the specified identity has permission to edit the attribute.
      Parameters:
      identity - The identity to check permissions for.
      Returns:
      true if the identity can edit the attribute, false otherwise.

    • getViewPermissions

      String getViewPermissions()
      Retrieves the view permissions for the current data attribute
      Returns:
      A String representing the permissions required for viewing the attribute

    • getEditPermissions

      String getEditPermissions()
      Retrieves the edit permissions for the current data attribute
      Returns:
      A String representing the permissions required for editing the attribute

    • getLess

      Number getLess()
      Retrieves the upper limit for the attribute (less than constraint).
      Returns:
      The upper limit for the attribute.

    • getGreater

      Number getGreater()
      Retrieves the lower limit for the attribute (greater than constraint).
      Returns:
      The lower limit for the attribute.

    • getLessEqual

      Number getLessEqual()
      Retrieves the upper limit (inclusive) for the attribute (less than or equal to constraint).
      Returns:
      The upper limit (inclusive) for the attribute.

    • getGreaterEqual

      Number getGreaterEqual()
      Retrieves the lower limit (inclusive) for the attribute (greater than or equal to constraint).
      Returns:
      The lower limit (inclusive) for the attribute.

    • getMaxLength

      Integer getMaxLength()
      Returns the maximum length allowed.
      Returns:
      the maximum length allowed

    • getMinLength

      Integer getMinLength()
      Returns a representing the minimum length property.
      Returns:
      An Optional<Integer> containing the minimum length property if present, otherwise an empty optional.

    • getPrecision

      Integer getPrecision()
      Returns a representing the precision property.
      Returns:
      An Optional<Integer> containing the precision property if present, otherwise an empty optional.

    • getRegExpPattern

      Pattern getRegExpPattern()

    • getFromDate

      LocalDate getFromDate()
      Returns the starting date of the range.
      Returns:
      the starting date of the range

    • getToDate

      LocalDate getToDate()
      Returns the ending date of the range.
      Returns:
      the ending date of the range

    • getHourRange

      IntegerSet getHourRange()
      Returns the set of hours allowed in the range.
      Returns:
      the set of hours allowed in the range

    • getMinuteRange

      IntegerSet getMinuteRange()
      Returns the set of minutes allowed in the range.
      Returns:
      the set of minutes allowed in the range

    • getTitle

      String getTitle()
      Retrieves the title.
      Returns:
      the title as a String.

    • getAriaLabel

      String getAriaLabel()
      Retrieves the ARIA label for accessibility purposes.
      Returns:
      the ARIA label as a String.

    • getAriaDescription

      String getAriaDescription()
      Retrieves the ARIA description for accessibility purposes.
      Returns:
      the ARIA description as a String.

    • getCleaner

      String getCleaner()
      Retrieves the cleaner, which could be used for formatting or sanitization.
      Returns:
      the cleaner as a String.

    • getValue

      String getValue()
      Retrieves the value associated with this object.
      Returns:
      the value as a String.

    • getKey

      String getKey()
      Retrieves the key associated with this object.
      Returns:
      the key as a String.

    • getHeadTitle

      String getHeadTitle()
      Retrieves the head title.
      Returns:
      the head title as a String.

    • getFalseTitle

      String getFalseTitle()
      Retrieves the false title.
      Returns:
      the false title as a String.

    • getEnabled

      String getEnabled()
      Retrieves the enabled status.
      Returns:
      the enabled status as a String.

    • getFormat

      String getFormat()
      Retrieves the format.
      Returns:
      the format as a String.

    • getRange

      String getRange()
      Retrieves the range.
      Returns:
      the range as a String.

    • getSymbols

      String getSymbols()
      Retrieves the symbols.
      Returns:
      the symbols as a String.

    • getPrefix

      String getPrefix()
      Retrieves the prefix.
      Returns:
      the prefix as a String.

    • getZoneName

      String getZoneName()
      Retrieves the zone name.
      Returns:
      the zone name as a String.

    • getZoneValue

      String getZoneValue()
      Retrieves the zone value.
      Returns:
      the zone value as a String.

    • getPlaceholder

      String getPlaceholder()
      Retrieves the placeholder text.
      Returns:
      the placeholder as a String.

    • getAutocomplete

      String getAutocomplete()
      Retrieves the autocomplete setting.
      Returns:
      the autocomplete setting as a String.

    • getLetterCase

      String getLetterCase()
      Retrieves the letter case setting.
      Returns:
      the letter case setting as a String.

    • getOutputPrecision

      String getOutputPrecision()
      Retrieves the output precision, which might indicate the number of decimal places or detail level.
      Returns:
      the output precision as a String.

    • getAriaDescriptionD

      String getAriaDescriptionD()
      Retrieves ARIA description for date
      Returns:
      the date ARIA description as a String.

    • getPlaceHolderD

      String getPlaceHolderD()
      Retrieves placeholder for date
      Returns:
      the secondary placeholder as a String.

    • getTitleD

      String getTitleD()
      Retrieves title for date.
      Returns:
      the secondary title as a String.

    • getFromName

      String getFromName()
      Retrieves the name of the field to use as "from" constraint.
      Returns:
      the "from" name as a String.

    • getToName

      String getToName()
      Retrieves the name of the field to use as "to" constraint.
      Returns:
      the "to" name as a String.

    • getAriaDescriptionT

      String getAriaDescriptionT()
      Retrieves ARIA description for time
      Returns:
      the ARIA description for time as a String.

    • getPlaceHolderT

      String getPlaceHolderT()
      Retrieves placeholder for time.
      Returns:
      the placeholder as a String.

    • getTitleT

      String getTitleT()
      Retrieves title for time context.
      Returns:
      the title as a String.

    • getMenuMinuteStep

      String getMenuMinuteStep()
      Retrieves the menu minute step.
      Returns:
      the menu minute step as a String.

    • getSearchThreshold

      String getSearchThreshold()
      Retrieves the search threshold, which might indicate a limit or criteria for search operations.
      Returns:
      the search threshold as a String.

    • getDictionaryPrefix

      String getDictionaryPrefix()
      Retrieves the dictionary prefix.
      Returns:
      the dictionary prefix as a String.

    • getMultiline

      String getMultiline()
      Retrieves the multiline setting, possibly indicating if multiple lines of text are supported.
      Returns:
      the multiline setting as a String.

    • getValueList

      List<String> getValueList()
      Retrieves a list of values associated with this object.
      Returns:
      a list of values as a List<String>.

    • getEntity

      Entity getEntity()
      Returns the associated Entity.
      Returns:
      the associated Entity.

    • getFullName

      default String getFullName()
      Returns a String about the full data attribute name, i.e. <extension column>.BaseDataAttribute.getName().
      Specified by:
      getFullName in interface BaseDataAttribute
      Returns:
      a String about the full data attribute name, i.e. <extension column>.BaseDataAttribute.getName().

    • getDateTypes

      overit.geocall.timezone.DateTypes getDateTypes()
      Returns a DateTypes about the configured type of date/time or time (local, central or symbolic).

      This value only makes sense in case of DataAttribute of type date/time or time.

      Returns:
      a DateTypes about the configured type of date/time or time (local, central or symbolic).