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

Interface QueryBuilderFilterAction<A extends QueryBuilderFilterAction<A>>

All Superinterfaces:

Action<A>, Comparable<A>, Copyable<A>, FilterAction<A>, Serializable

All Known Implementing Classes:

DefaultQueryBuilderFilterAction

public interface QueryBuilderFilterAction<A extends QueryBuilderFilterAction<A>>
extends FilterAction<A>

Represents the metadata for a query builder filter action. This interface provides helper methods to assist in configuring the set of filterable fields.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	QueryBuilderFilterAction.Keys

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.filters.FilterAction

FilterAction.Attributes

Method Summary

Modifier and Type	Method	Description
default A	addField(Field<?> field)
default A	addField(String name)
default A	addField(String name, Field<?> field)
default A	addFields(Collection<Field<?>> fields)
default A	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)
default Field<?>	getField(String name)
default A	removeField(String name)	Removes a field with the given name.

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

addComponent, addComponents, addEndpoint, addEndpoint, apply, attribute, clearEndpoints, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAttribute, getAttribute, getAttributes, getComponent, getComponent, getComponents, getComponentsList, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOperationType, getOrder, getPlacement, getScope, getType, hasAttribute, hasComponent, hasEndpoint, id, label, label, operationType, order, placement, removeAttribute, removeComponent, removeEndpoint, scope, self, setAttributes, setComponents, setEndpoints, setId, setLabel, setOperationType, setOrder, setPlacement, setScope, setType, type

Methods inherited from interface java.lang.Comparable

compareTo

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

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.filters.FilterAction

filterKey, getFilterKey

Method Details

addField

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

addField

default A addField(Field<?> field)

addField

default A addField(String name)

addFields

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

removeField

default A removeField(String name)

Removes a field with the given name.

Parameters:

name - the name of the field

Returns:

this

field

default A 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)

getField

default Field<?> getField(String name)