Package de.xima.fc.interfaces.workflow.value

Interface IProperty

  • All Superinterfaces:
    Serializable
    public interface IProperty
extends Serializable
    Describes a property that is part of a value. For example, a record value consists of key-value pairs, each pair is a property.
    Since:
    7.0.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • getDescriptionI18n

        String getDescriptionI18n()
        Returns:
        Description for the property.

      • getDisplayPath

        String getDisplayPath()
        Returns:
        Sipmle path to access this property, starting at the root value.

      • getJsonPath

        String getJsonPath()
        Returns:
        JSON path to access this property, starting at the root value.

      • getBaseType

        EValueType getBaseType()
        Returns:
        Base type of this property's value.

      • getFullType

        String getFullType()
        Returns:
        Full type of this property's value.

      • getDefaultValue

        Object getDefaultValue()
        Returns:
        Default value for this property when no explicit value is provided.

      • isOptional

        boolean isOptional()
        Returns:
        Whether this property must be present in the parent property. For example, a property of a record may be optional.

      • getNestingLevel

        int getNestingLevel()
        Returns:
        The nesting level of this property relative to the root value.

      • optional

        IProperty optional()
        Returns:
        A new property instance marked as optional

      • withDefaultDescription

        IProperty withDefaultDescription​(String description)
        Parameters:
        description - New description for this property, may be either a localized message or an I18N key.
        Returns:
        A new property instance with the given description.