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

Interface ImportGrid<G extends ImportGrid<G>>

All Superinterfaces:

ActionGrid<G>, Comparable<G>, Component<G>, Copyable<G>, CustomCssComponent<G>, Grid<G>, Serializable

All Known Subinterfaces:

EntityGridView<V>, ExportHistoryEntityGridView<V>, ExportHistoryGridExternal<E>, GridExternal<E>

All Known Implementing Classes:

DefaultEntityGridView, DefaultExportHistoryEntityGridView, DefaultExportHistoryGridExternal, DefaultGridExternal

public interface ImportGrid<G extends ImportGrid<G>>
extends ActionGrid<G>

An extension of ActionGrid to represent a grid with a grid-level import action.

The example of usages:

 grid.importGridAction("IMPORT_TYPE", "SCOPE_FOR_THIS_ENTITY")
 

Author:

Dima Myroniuk (dmyroniuk)

Nested Class Summary

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

ActionGrid.ActionKeys, ActionGrid.ActionPlacements, ActionGrid.ActionTypes

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

Grid.Attributes, Grid.Keys

Field Summary

Fields inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent

CSS_ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
default G	addImportGridAction(ImportGridAction<?> action)	Adds the grid-level import action to import the entities from this grid.
default G	importGridAction(String importType, String scope)	Adds the grid-level import action to import the entities from this grid.
default G	importGridAction(String importType, String scope, UnaryOperator<ImportGridAction<?>> fn)	Adds the grid-level import action to import the entities from this grid.
default G	removeImportGridAction()	Removes the grid-level import action.

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

addGridAction, addGridAction, addGridActionGroup, addRowAction, addRowAction, findGridAction, findRowAction, getGridAction, getRowAction, gridAction, removeGridAction, removeRowAction, rowAction

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

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

addCssClass, addCssClass, addCssClass, clearCssClasses, getCssClasses, removeCssClass, removeCssClass, removeCssClass

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

addColumn, addColumn, addColumn, addColumns, addRowMessage, addRowMessage, findColumn, findRowMessage, getColumn, getRowMessage, idKey, removeColumn, removeRowMessage, rowMessage

Method Details

importGridAction

default G importGridAction(String importType,
 String scope)

Adds the grid-level import action to import the entities from this grid.

Parameters:

importType - the type of the import

scope - the OAuth2 scope

Returns:

this grid for further customization

importGridAction

default G importGridAction(String importType,
 String scope,
 UnaryOperator<ImportGridAction<?>> fn)

Adds the grid-level import action to import the entities from this grid.

Parameters:

importType - the type of the import

scope - the OAuth2 scope

fn - the added action for further customization

Returns:

this grid for further customization

addImportGridAction

default G addImportGridAction(ImportGridAction<?> action)

Adds the grid-level import action to import the entities from this grid.

Parameters:

action - the ImportGridAction action

Returns:

this grid for further customization

removeImportGridAction

default G removeImportGridAction()

Removes the grid-level import action.

Returns:

this grid for further customization