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 class	BuilderFieldSource.Attributes

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 String	getContainerKey()
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, findComponent, findComponent, findComponents, 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

Method Detail

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)