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

Interface GridExternal<E extends GridExternal<E>>

All Superinterfaces:
ActionGrid<E>, Comparable<E>, Component<E>, Copyable<E>, CustomCssComponent<E>, Dependent<E>, ExportGrid<E>, External<E>, FetchGrid<E>, Filterable<E>, FilterableGrid<E>, FormComponent<E>, Grid<E>, ImportGrid<E>, Orderable<E>, Pollable<E>, ResourceGrid<E>, Selectable<E>, Serializable, SortableGrid<E>, Trackable<E>
All Known Subinterfaces:
ExportHistoryGridExternal<E>
All Known Implementing Classes:
DefaultExportHistoryGridExternal, DefaultGridExternal
public interface GridExternal<E extends GridExternal<E>> extends ActionGrid<E>, ImportGrid<E>, ExportGrid<E>, Dependent<E>, External<E>, FetchGrid<E>, FilterableGrid<E>, Orderable<E>, Pollable<E>, ResourceGrid<E>, Selectable<E>, SortableGrid<E>, Trackable<E>
Represents the metadata for a grid that provides a view of external data related to the form it resides within. Supports retrieving, creating, updating, and deleting the data for a collection.
Author:
Nick Crum (ncrum)

  • Method Details

    • skipSandboxing

      default E skipSandboxing()
      Forces disabling sandbox trackable behavior for the component.
      Since:
      Metadata 2.0.8, Release Train 2.1.6, 2.2.2

    • removeSkipSandboxing

      default E removeSkipSandboxing()
      Removes the attribute forcing disabling sandbox trackable behavior for the component.
      Since:
      Metadata 2.0.8, Release Train 2.1.6, 2.2.2

    • listensFor

      default E listensFor(Map<String,List<String>> gridIdsAndOperations)
      Configure the other external grids within the InterdependentExternalGridsGroup that this grid will be listening for. This means that if a change is made to any of the configured grids (see GridExternal.GridListenerOperations), then this grid will be refreshed (i.e. the configured READ endpoint for the grid will be called). Operations can also be defined for each dependent grid to allow for conditional updates, but are not required. The operations are expected to be GridExternal.GridListenerOperations so that this grid is refreshed depending on the operation done on the grid being listened to.

      This will only take effect if all affected grids are in the same InterdependentExternalGridsGroup.

      Parameters:
      gridIdsAndOperations - a map of grid IDs mapped to operations that this grid will be listening for
      Returns:
      this external grid
      Since:
      Metadata 2.0.8, Release Train 2.1.6, 2.2.2
      See Also:

    • removeDependentGrids

      default E removeDependentGrids()
      Removes the attribute configuring the map of grids and their operations that this grid listens for.
      Returns:
      this external grid
      Since:
      Metadata 2.0.8, Release Train 2.1.6, 2.2.2