ExportGrid (Broadleaf Metadata Common 1.7.3-GA API)

All Superinterfaces:

ActionGrid<G>, Comparable<G>, Component<G>, Copyable<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 ExportGrid<G extends ExportGrid<G>>
extends ActionGrid<G>
```
An extension of ActionGrid to represent a grid with a grid-level export action.
The example of usages:
```
 grid.exportGridAction("SCOPE", action -> action
         .startExportEndpoint(endpoint -> endpoint.uri("/start-export-uri"))
         .readExportEndpoint(endpoint -> endpoint.uri("/read-export-by-id-uri/${exportId}"))
         .downloadExportUri("/api/export/${exportId}/download")
         .nameField("EXPORT_TYPE"))
 
```
Author:

Dima Myroniuk (dmyroniuk)

Nested Class Summary
- Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ActionGrid
  ActionGrid.ActionKeys, ActionGrid.ActionPlacements
- Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Grid
  Grid.Attributes, Grid.Keys

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default G`	`addExportGridAction(ExportGridAction<?> action)`	Adds the grid-level export action to export the entities from this grid.
`default G`	`exportGridAction(String scope, UnaryOperator<ExportGridAction<?>> fn)`	Adds the grid-level export action to export the entities from this grid.
`default G`	`removeExportGridAction()`	Removes the grid-level export action.

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ActionGrid
addGridAction, addGridAction, 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, 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.Grid
addColumn, addColumn, addColumn, addColumns, findColumn, getColumn, idKey, removeColumn

- Method Detail
  - exportGridAction
```
default G exportGridAction(String scope,
                           UnaryOperator<ExportGridAction<?>> fn)
```
    Adds the grid-level export action to export the entities from this grid.
    
    Parameters:
    
    scope - the OAuth2 scope
    
    fn - the added action for further customization
    
    Returns:
    
    this grid for further customization
  - addExportGridAction
```
default G addExportGridAction(ExportGridAction<?> action)
```
    Adds the grid-level export action to export the entities from this grid.
    
    Parameters:
    
    action - the ImportGridAction action
    
    Returns:
    
    this grid for further customization
  - removeExportGridAction
```
default G removeExportGridAction()
```
    Removes the grid-level export action.
    
    Returns:
    
    this grid for further customization