Package com.broadleafcommerce.metadata.dsl.core.extension.fields

Interface QueryBuilderField<F extends QueryBuilderField<F>>

All Superinterfaces:

BuilderFieldSource<F>, Comparable<F>, Component<F>, Copyable<F>, Field<F>, FormComponent<F>, Serializable

All Known Implementing Classes:

DefaultQueryBuilderField

public interface QueryBuilderField<F extends QueryBuilderField<F>>
extends Field<F>, BuilderFieldSource<F>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	QueryBuilderField.Keys

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.BuilderFieldSource

BuilderFieldSource.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Field

Field.Attributes

Field Summary

Fields inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.BuilderFieldSource

FIELD_NAME_PATTERN, FIELD_NAME_REGEX

Method Summary

Modifier and Type	Method	Description
default F	addField(Field<?> field)	Add a field as a child to the current field Field.
default F	addField(String name)	Add a field as a child to the current field with the provided name.
default F	addField(String name, Field<?> field)	Add a field as a child to the current field with the provided name and Field.
default F	addFields(Collection<Field<?>> fields)	Add a collection of fields as children to the current field.
default F	field(String name, UnaryOperator<Field<?>> fn)	Selects or creates a field with the given name and provides it as an argument to the function for further customization.
default Optional<Field<?>>	findField(String name)	Finds a field with the specified name.
default Field<?>	getField(String name)	Gets a field with the specified name.
default F	removeField(String name)	Removes a field with the given name.

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.BuilderFieldSource

addAugmentationFieldSource, addAugmentationFieldSource, addAugmentationFieldSource, addAugmentationFieldSource, allowCustomFields, allowCustomFields, getContainerKey, isAllowCustomFields, isStripAttributes, notAllowCustomFields, processFieldName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Field

clearReadOnlyConditionals, decorated, decorated, defaultValue, getDefaultValue, getName, getPlaceholder, getReadOnlyConditionals, getRequiredMessage, getValidationSchema, isReadOnly, isRequired, isShowInQueryBuilder, isTargetCollection, name, notReadOnly, notRequired, placeholder, placeholder, readOnly, readOnly, readOnlyConditional, readOnlyConditionals, required, required, required, required, requiredMessage, requiredMessage, setDefaultValue, setName, setPlaceholder, setReadOnly, setReadOnlyConditionals, setRequired, setRequiredMessage, setShowInQueryBuilder, setValidationSchema, targetIsCollection, targetIsNotCollection, validationMethod, validationSchema, validationSchema

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.FormComponent

getHelpText, getHint, getTooltip, helpText, helpText, helpText, hidden, hidden, hint, hint, isHidden, notHidden, setHelpText, setHidden, setHint, setTooltip, tooltip, tooltip

Method Details

addField

default F addField(String name,
 Field<?> field)

Add a field as a child to the current field with the provided name and Field.

Parameters:

name - the name of the field

field - the Field object added

Returns:

this

addField

default F addField(Field<?> field)

Add a field as a child to the current field Field. The field must have a name already attached.

Parameters:

field - the Field object added

Returns:

this

addField

default F addField(String name)

Add a field as a child to the current field with the provided name. The field is set to a string and will autogenerate a label based on the name.

Parameters:

name - the name of the field

Returns:

this

addFields

default F addFields(Collection<Field<?>> fields)

Add a collection of fields as children to the current field.

Parameters:

fields - A collection of fields

Returns:

this

removeField

default F removeField(String name)

Removes a field with the given name.

Parameters:

name - the name of the field

Returns:

this

field

default F field(String name,
 UnaryOperator<Field<?>> fn)

Selects or creates a field with the given name and provides it as an argument to the function for further customization.

Parameters:

name - the name of the field

fn - the customize function

Returns:

this

findField

default Optional<Field<?>> findField(String name)

Finds a field with the specified name.

Parameters:

name - the name of the field to find

Returns:

The field if it is found, otherwise null

getField

default Field<?> getField(String name)

Gets a field with the specified name.

Parameters:

name - the name of the field to get

Returns:

The field if it is found, otherwise throws exception