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

Interface EntityBrowseView<V extends EntityBrowseView<V>>

All Superinterfaces:

Comparable<V>, Component<V>, Copyable<V>, Serializable, View<V>

All Known Implementing Classes:

DefaultEntityBrowseView

public interface EntityBrowseView<V extends EntityBrowseView<V>>
extends View<V>

Author:

Nick Crum (ncrum)

Method Summary

Modifier and Type	Method and Description
default V	addDefaultGrid(EntityGridView<?> grid)
default V	addGrid(String id, EntityGridView<?> grid)
default V	defaultGrid(UnaryOperator<EntityGridView<?>> fn)
default V	exportHistoryGrid(UnaryOperator<ExportHistoryEntityGridView<?>> fn) Adds the export history grid.
default Optional<ExportHistoryEntityGridView<?>>	findExportHistoryGrid() Search the export history grid view.
default Optional<EntityGridView<?>>	findGrid(String id)
default EntityGridView<?>	getDefaultGrid()
default ExportHistoryEntityGridView<?>	getExportHistoryGrid() Returns the ExportHistoryEntityGridView if it exists.
default EntityGridView<?>	getGrid(String id)
default V	grid(String id, UnaryOperator<EntityGridView<?>> fn)
default V	removeExportHistoryGrid() Removes the export history grid.

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 java.lang.Comparable

compareTo

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

copy

Method Detail

addGrid

default V addGrid(String id,
                  EntityGridView<?> grid)

addDefaultGrid

default V addDefaultGrid(EntityGridView<?> grid)

grid

default V grid(String id,
               UnaryOperator<EntityGridView<?>> fn)

defaultGrid

default V defaultGrid(UnaryOperator<EntityGridView<?>> fn)

exportHistoryGrid

default V exportHistoryGrid(UnaryOperator<ExportHistoryEntityGridView<?>> fn)

Adds the export history grid.

Parameters:

fn - the added ExportHistoryEntityGridView for further customization

Returns:

this view for further customization

removeExportHistoryGrid

default V removeExportHistoryGrid()

Removes the export history grid.

Returns:

this view for further customization

findExportHistoryGrid

default Optional<ExportHistoryEntityGridView<?>> findExportHistoryGrid()

Search the export history grid view.

Returns:

the found ExportHistoryEntityGridView

getExportHistoryGrid

default ExportHistoryEntityGridView<?> getExportHistoryGrid()

Returns the ExportHistoryEntityGridView if it exists.

Returns:

the found ExportHistoryEntityGridView

Throws:

IllegalArgumentException - if there is no grid for export history

getGrid

default EntityGridView<?> getGrid(String id)

getDefaultGrid

default EntityGridView<?> getDefaultGrid()

findGrid

default Optional<EntityGridView<?>> findGrid(String id)