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

Interface ExportGrid<G extends ExportGrid<G>>

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)

  • Method Details

    • 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