Package com.broadleafcommerce.metadata.dsl.core

Interface Field<F extends Field<F>>

    • Method Detail

      • getName

        @Nullable
String getName()

      • getDefaultValue

        @Nullable
Object getDefaultValue()

      • isReadOnly

        boolean isReadOnly()

      • isRequired

        boolean isRequired()

      • isShowInQueryBuilder

        boolean isShowInQueryBuilder()

      • setName

        void setName​(String name)

      • setDefaultValue

        void setDefaultValue​(Object defaultValue)

      • setReadOnly

        void setReadOnly​(boolean readOnly)

      • setReadOnlyConditionals

        void setReadOnlyConditionals​(List<Conditional<?>> readOnlyConditionals)

      • setRequired

        void setRequired​(boolean required)

      • setShowInQueryBuilder

        void setShowInQueryBuilder​(boolean showInQueryBuilder)

      • name

        default F name​(String name)

      • defaultValue

        default F defaultValue​(Object defaultValue)

      • readOnly

        default F readOnly()

      • notReadOnly

        default F notReadOnly()

      • readOnly

        default F readOnly​(boolean readOnly)

      • readOnlyConditionals

        default F readOnlyConditionals​(List<Conditional<?>> readOnlyConditionals)

      • readOnlyConditional

        default F readOnlyConditional​(Conditional<?>... conditionals)

      • clearReadOnlyConditionals

        default F clearReadOnlyConditionals()

      • required

        default F required()

      • notRequired

        default F notRequired()

      • required

        default F required​(boolean required)

      • required

        default F required​(String requiredMessageKey)

      • requiredMessage

        default F requiredMessage​(String requiredMessageKey)

      • placeholder

        default F placeholder​(String placeholderKey)

      • validationMethod

        default F validationMethod​(ValidationMethod<?> validationMethod)

      • decorated

        default F decorated​(boolean decorated)
        Set whether or not this field should be decorated with a label, help text, hint, and other elements.
        Parameters:
        decorated - whether or not decorated
        Returns:
        this field for further customization

      • isTargetCollection

        default F isTargetCollection​(boolean isTargetCollection)
        If the field is used in a rule builder, this indicates that the field that is targeted by the rule is a collection field. This impacts the verbiage used in the admin to describe the rule such as "is in" or "is a subset of".
        Parameters:
        isTargetCollection - Whether the target field is a collection.
        Returns:
        this

      • targetIsCollection

        default F targetIsCollection()
        If the field is used in a rule builder, this indicates that the field that is targeted by the rule is a collection field. This impacts the verbiage used in the admin to describe the rule such as "is in" or "is a subset of".
        Returns:
        this

      • targetIsNotCollection

        default F targetIsNotCollection()
        If the field is used in a rule builder, this indicates that the field that is targeted by the rule is a not collection field. This impacts the verbiage used in the admin to describe the rule such as "is in" or "is a subset of".
        Returns:
        this