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

Interface BuilderFieldSource<D extends BuilderFieldSource<D>>

All Superinterfaces:

Comparable<D>, Component<D>, Copyable<D>, Serializable

All Known Subinterfaces:

QueryBuilderField<F>, RuleBuilderField<F>

All Known Implementing Classes:

DefaultQueryBuilderField, DefaultRuleBuilderField

public interface BuilderFieldSource<D extends BuilderFieldSource<D>>
extends Component<D>

An interface implemented by components that intend to support the inclusion of augmented custom fields.

Author:

Jon Fleschler (jfleschler)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BuilderFieldSource.Attributes

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	FIELD_NAME_PATTERN
static final String	FIELD_NAME_REGEX

Method Summary

Modifier and Type	Method	Description
default D	addAugmentationFieldSource(String entityContainerKey)	The container key used to retrieve augmentations.
default D	addAugmentationFieldSource(String entityContainerKey, boolean stripAttributes)	The container key used to retrieve augmentations.
default D	addAugmentationFieldSource(String entityContainerKey, String fieldNameWrapper)	The container key used to retrieve augmentations.
default D	addAugmentationFieldSource(String entityContainerKey, String fieldNameWrapper, boolean stripAttributes)	The container key used to retrieve augmentations.
default D	allowCustomFields()	Set to allow the builder field to be augmented with custom fields.
default D	allowCustomFields(boolean allow)	Set whether to allow the builder field to be augmented with custom fields.
default String	getContainerKey()
default boolean	isAllowCustomFields()	Whether builder field is allowed to be augmented with custom fields.
default boolean	isStripAttributes()
default D	notAllowCustomFields()	Set to not allow the builder field to be augmented with custom fields.
default String	processFieldName(String fieldName)

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

Field Details

FIELD_NAME_REGEX

static final String FIELD_NAME_REGEX

See Also:

• Constant Field Values

FIELD_NAME_PATTERN

static final Pattern FIELD_NAME_PATTERN

Method Details

addAugmentationFieldSource

default D addAugmentationFieldSource(String entityContainerKey)

The container key used to retrieve augmentations. Any fields marked `showInQueryBuilder` will be added to the field list.

Parameters:

entityContainerKey - the augmentation key property

Returns:

this

addAugmentationFieldSource

default D addAugmentationFieldSource(String entityContainerKey,
 boolean stripAttributes)

The container key used to retrieve augmentations. Any fields marked `showInQueryBuilder` will be added to the field list.

Parameters:

entityContainerKey - the augmentation key property

Returns:

this

addAugmentationFieldSource

default D addAugmentationFieldSource(String entityContainerKey,
 String fieldNameWrapper)

The container key used to retrieve augmentations. Any fields marked `showInQueryBuilder` will be added to the field list.

Parameters:

entityContainerKey - the augmentation key property

fieldNameWrapper - the string format to wrap the field name

Returns:

this

addAugmentationFieldSource

default D addAugmentationFieldSource(String entityContainerKey,
 String fieldNameWrapper,
 boolean stripAttributes)

The container key used to retrieve augmentations. Any fields marked `showInQueryBuilder` will be added to the field list.

Parameters:

entityContainerKey - the augmentation key property

fieldNameWrapper - the string format to wrap the field name

Returns:

this

getContainerKey

default String getContainerKey()

processFieldName

default String processFieldName(String fieldName)

isStripAttributes

default boolean isStripAttributes()

allowCustomFields

default D allowCustomFields()

Set to allow the builder field to be augmented with custom fields.

Returns:

this.

Since:

Metadata 2.0.6

allowCustomFields

default D allowCustomFields(boolean allow)

Set whether to allow the builder field to be augmented with custom fields.

Parameters:

allow - The value to set.

Returns:

this.

Since:

Metadata 2.0.6

notAllowCustomFields

default D notAllowCustomFields()

Set to not allow the builder field to be augmented with custom fields.

Returns:

this.

Since:

Metadata 2.0.6

isAllowCustomFields

default boolean isAllowCustomFields()

Whether builder field is allowed to be augmented with custom fields.

Returns:

this.

Since:

Metadata 2.0.6