Package com.broadleafcommerce.metadata.dsl.core

Interface Field<F extends Field<F>>

All Superinterfaces:
Comparable<F>, Component<F>, Copyable<F>, FormComponent<F>, Serializable
All Known Subinterfaces:
ComputedField<F>, CustomAttributesGridField<F>, DateField<F>, DateRangeField<F>, DerivedField<F>, DerivedSelectField<F>, DerivedUrlField<F>, DurationField<F>, DynamicField<F>, EnumSwitchField<F>, FieldArrayBlockField<F>, FieldArrayField<F>, FieldArrayGridField<F>, FileInputField<F>, IntegerField<F>, LookupField<F>, MoneyField<F>, PhoneField<F>, QueryBuilderField<F>, ResidentGridField<F>, ResidentMapField<F>, RuleBuilderField<F>, SelectField<F>
All Known Implementing Classes:
AbstractField, DefaultComputedField, DefaultCustomAttributesGridField, DefaultDateField, DefaultDateRangeField, DefaultDerivedField, DefaultDerivedSelectField, DefaultDerivedUrlField, DefaultDurationField, DefaultDynamicField, DefaultEnumSwitchField, DefaultField, DefaultFieldArrayBlockField, DefaultFieldArrayGridField, DefaultFileInputField, DefaultIntegerField, DefaultLookupField, DefaultMoneyField, DefaultPhoneField, DefaultQueryBuilderField, DefaultResidentGridField, DefaultResidentMapField, DefaultRuleBuilderField, DefaultSelectField
public interface Field<F extends Field<F>> extends FormComponent<F>
Represents the metadata for a field component.
Author:
Nick Crum (ncrum)

  • Method Details

    • getName

      @Nullable String getName()

    • getDefaultValue

      @Nullable Object getDefaultValue()

    • isReadOnly

      boolean isReadOnly()

    • getMaxLength

      int getMaxLength()
      Since:
      Metadata 2.0.8, Release Train 2.1.6

    • isRequired

      boolean isRequired()

    • isShowInQueryBuilder

      boolean isShowInQueryBuilder()

    • getReadOnlyConditionals

      List<Conditional<?>> getReadOnlyConditionals()

    • getRequiredMessage

      @Nullable InternationalizedMessage getRequiredMessage()

    • getPlaceholder

      @Nullable InternationalizedMessage getPlaceholder()

    • getValidationSchema

      @Nullable AbstractValidationSchema<?> getValidationSchema()

    • 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)

    • setMaxLength

      void setMaxLength(int maxLength)

    • setShowInQueryBuilder

      void setShowInQueryBuilder(boolean showInQueryBuilder)

    • setRequiredMessage

      void setRequiredMessage(InternationalizedMessage requiredMessage)

    • setPlaceholder

      void setPlaceholder(InternationalizedMessage placeholder)

    • setValidationSchema

      void setValidationSchema(AbstractValidationSchema<?> validationSchema)

    • 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)

    • required

      default F required(InternationalizedMessage requiredMessage)

    • requiredMessage

      default F requiredMessage(InternationalizedMessage requiredMessage)

    • requiredMessage

      default F requiredMessage(String requiredMessageKey)

    • maxLength

      default F maxLength(int maxLength)
      Since:
      Metadata 2.0.8, Release Train 2.1.6

    • noMaxLength

      default F noMaxLength()
      Since:
      Metadata 2.0.8, Release Train 2.1.6

    • placeholder

      default F placeholder(InternationalizedMessage placeholder)

    • placeholder

      default F placeholder(String placeholderKey)

    • validationSchema

      default F validationSchema(AbstractValidationSchema<?> validationSchema)

    • validationSchema

      default F validationSchema(UnaryOperator<AbstractValidationSchema<?>> fn)

    • validationMethod

      default F validationMethod(ValidationMethod<?> validationMethod)

    • decorated

      default F decorated()
      Sets the field as decorated.
      Returns:
      this field for further customization

    • 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

    • displayOnly

      default F displayOnly()
      Sets the field as display only. This means that the field will not be displayed as it usually does when it can be interacted with, but as a plain or raw text representation.
      Returns:
      this field for further customization
      Since:
      Metadata Service 2.0.8, Release Train 2.1.6

    • displayOnly

      default F displayOnly(boolean displayOnly)
      Set whether this field should be displayed as a plain or raw text representation of the field.
      Parameters:
      displayOnly - whether to show fields as raw text
      Returns:
      this field for further customization
      Since:
      Metadata Service 2.0.8, Release Train 2.1.6