Package se.conciliate.extensions.store

Interface MTAttributeTypeHeader

All Superinterfaces:
Comparable<MTNamedObject>, MTNamedObject
All Known Subinterfaces:
MTAttributeType
public interface MTAttributeTypeHeader extends MTNamedObject
Header interface for attribute types. There can be one or more attribute types in a repository (there is always at least the default attribute type). These attribute types can then be connected to symbol types (or models) to determine the available attributes for a symbol or model. For more information about attributes and its types, see MTAttributeHeader.
Since:
5.0
See Also:

  • Method Details

    • getLastModified

      Date getLastModified()
      Returns the time when the attribute type was last modified.
      Returns:
      The last modified time.
      Since:
      5.0

    • getSummary

      String getSummary()
      Returns the summary in the current language.
      Returns:
      The summary in the current language.
      Since:
      5.0

    • getSummary

      String getSummary(MTLanguageHeader language)
      Returns the summary in a given language.
      Parameters:
      language - The language.
      Returns:
      The summary in the language language.
      Since:
      5.0

    • expand

      MTAttributeType expand() throws MTAccessException
      Returns a MTAttributeType for this attribute type. Note that this might require querying the storage layer for more data.
      Returns:
      A MTAttributeType representing this attribute type.
      Throws:
      MTAccessException - If an MTAccessException occurs.
      Since:
      5.0

    • getInputType

      String getInputType()
      Returns the input type of this attribute type. An input type is a string that can be used by clients of this class to determine what kind of input widget to use to create attributes of this attribute type. The default is 'rich-text-editor'.

      Note that this object takes no responsibility when it comes to the input widget understanding how to parse the data according to this objects data type. It is thus possible to construct attribute types that has a 'date-picker' as input type and a 'currency' as data type. The input type widget will likely fail to understand the data in such cases.
      Returns:
      the input type of this attribute type. The default is 'rich-text-editor'.
      Since:
      5.0

    • getDataType

      String getDataType()
      Returns the data type of this attribute type. The data type is a unique id used to denote how the data (the String-data in the attribute) is structured. Data types can, as an example, be 'number' or 'date' or 'better-number'. How to parse data of any given type is up to the caller or some class that the caller knows about.
      Returns:
      The data type of this attribute type. The default is 'se.conciliate.rich.text'.
      Since:
      5.0

    • getRefinement

      String getRefinement()
      Returns the refinement of this attribute type. A refinement is a string representing valid input for attributes of this type. It is separate from the data type of the attribute type in that e.g. a data type of "number" might have further validation restrictions such as "only numbers between 1 and 100". The returned refinement is localized for the current language.
      Returns:
      A string representation of the validation refinement on this attribute type's data type.
      Since:
      5.0

    • getRefinement

      String getRefinement(MTLanguageHeader language)
      Returns the refinement of this attribute type in the given language.
      Parameters:
      language - The language to localize the refinement to
      Returns:
      the refinement of this attribute type in the given language.
      Since:
      5.0
      See Also:

    • getIconURL

      URL getIconURL()
      Returns the icon URL.
      Returns:
      the icon URL.

    • getIconURL

      default URL getIconURL(int size)