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

Interface SelectTargetEntityGridView<V extends SelectTargetEntityGridView<V>>

All Superinterfaces:

Comparable<V>, Component<V>, Copyable<V>, FetchGrid<V>, Grid<V>, Selectable<V>, Serializable, SortableGrid<V>, Trackable<V>, View<V>

All Known Implementing Classes:

DefaultSelectTargetEntityGridView

public interface SelectTargetEntityGridView<V extends SelectTargetEntityGridView<V>>
extends FetchGrid<V>, SortableGrid<V>, Selectable<V>, View<V>, Trackable<V>

This grid is used to fetch and display the entities to export.

Author:

Dima Myroniuk (dmyroniuk)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SelectTargetEntityGridView.ActionIds
static final class	SelectTargetEntityGridView.Attributes

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

FetchGrid.EndpointTypes

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

Grid.Keys

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

Selectable.ConfigureSelectable, Selectable.SelectableTypes

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

SortableGrid.Sort

Method Summary

Modifier and Type	Method	Description
default V	filterTargetEntities(UnaryOperator<QueryBuilderFilterAction<?>> fn)	Adds the filter action to have an ability to filter the entities in the grid.
default V	readTargetEntitiesEndpoint(UnaryOperator<PageableEndpoint<?>> fn)	Adds the endpoint to read the entities.
default V	selectCatalogFieldLabel(String label)	Sets the label for the catalog selector field.
default V	selectCatalogFieldPlaceholder(String placeholder)	Sets the placeholder for the catalog selector field.
default V	selectSandboxFieldLabel(String label)	Sets the label for the sandbox selector field.
default V	selectSandboxFieldPlaceholder(String placeholder)	Sets the placeholder for the sandbox selector field.

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

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

findReadEndpoint, getReadEndpoint, getReadEndpointType, narrowedPaging, narrowedPaging, numberedPaging, numberedPaging, readEndpoint, readEndpoint, readScope, readUrl, readUrl, unpaged

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

addColumn, addColumn, addColumn, addColumns, findColumn, getColumn, idKey, removeColumn

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

multiPageSelectable, multiPageSelectableWithExclusions, multipleSelectable, notSelectable, selectable, selectable, selectable, selectableType, singleSelectable

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

notSortable, notSortable, sortable, sortable, sortableWithDefault, sortableWithDefault

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

catalogTrackable, notCatalogTrackable, notProfileTrackable, notSandboxTrackable, profileTrackable, sandboxTrackable

Method Details

readTargetEntitiesEndpoint

default V readTargetEntitiesEndpoint(UnaryOperator<PageableEndpoint<?>> fn)

Adds the endpoint to read the entities.

Parameters:

fn - the function to customize the endpoint

Returns:

this grid for further customization

filterTargetEntities

default V filterTargetEntities(UnaryOperator<QueryBuilderFilterAction<?>> fn)

Adds the filter action to have an ability to filter the entities in the grid.

Parameters:

fn - the function to customize the action

Returns:

this grid for further customization

selectCatalogFieldLabel

default V selectCatalogFieldLabel(String label)

Sets the label for the catalog selector field.

Parameters:

label - the message key for the catalog selector field label

Returns:

this grid for further customization

selectCatalogFieldPlaceholder

default V selectCatalogFieldPlaceholder(String placeholder)

Sets the placeholder for the catalog selector field.

Parameters:

placeholder - the message key for the catalog selector field placeholder

Returns:

this grid for further customization

selectSandboxFieldLabel

default V selectSandboxFieldLabel(String label)

Sets the label for the sandbox selector field.

Parameters:

label - the message key for the sandbox selector field label

Returns:

this grid for further customization

selectSandboxFieldPlaceholder

default V selectSandboxFieldPlaceholder(String placeholder)

Sets the placeholder for the sandbox selector field.

Parameters:

placeholder - the message key for the sandbox selector field placeholder

Returns:

this grid for further customization