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

Interface ExportGridAction<A extends ExportGridAction<A>>

All Superinterfaces:
Action<A>, Comparable<A>, Copyable<A>, FormAction<A>, Serializable
All Known Implementing Classes:
DefaultExportGridAction
public interface ExportGridAction<A extends ExportGridAction<A>> extends FormAction<A>
This action is used to open the modal dialog with additional configuration to export the entities from the grid.
Author:
Dima Myroniuk (dmyroniuk)

  • Method Details

    • startExportEndpoint

      default A startExportEndpoint(UnaryOperator<Endpoint<?>> fn)
      Adds the endpoint to start the export.
      Parameters:
      fn - the added endpoint for further customization
      Returns:
      this action for further customization

    • addStartExportEndpoint

      default A addStartExportEndpoint(Endpoint<?> endpoint)
      Adds the endpoint to start the export.
      Parameters:
      endpoint - the endpoint to start the export
      Returns:
      this action for further customization

    • removeStartExportEndpoint

      default A removeStartExportEndpoint()
      Removes the endpoint to start the export.
      Returns:
      this action for further customization

    • readExportEndpoint

      default A readExportEndpoint(UnaryOperator<Endpoint<?>> fn)
      Adds the endpoint to read the export by id. To specify the export id in the uri use "${exportId}" e.g. "/export/${exportId}".
      Parameters:
      fn - the added endpoint for further customization
      Returns:
      this action for further customization

    • addReadExportEndpoint

      default A addReadExportEndpoint(Endpoint<?> endpoint)
      Adds the endpoint to read the export by id.
      Parameters:
      endpoint - the endpoint to read the export by id
      Returns:
      this action for further customization

    • removeReadExportEndpoint

      default A removeReadExportEndpoint()
      Removes the endpoint to read the export by id.
      Returns:
      this action for further customization

    • nameField

      default A nameField(String exportType)
      Adds the field for the export name into a modal dialog form.
      Parameters:
      exportType - the export type. This is used to create the default name like: "exportType + " - $TIMESTAMP""
      Returns:
      this action for further customization

    • nameField

      default A nameField(UnaryOperator<Field<?>> fn)
      Adds the field for the export name into a modal dialog form.
      Parameters:
      fn - the added field for further customization
      Returns:
      this action for further customization

    • addNameField

      default A addNameField(Field<?> field)
      Adds the field for the export name into a modal dialog form.
      Parameters:
      field - the added field for further customization
      Returns:
      this action for further customization

    • removeNameField

      default A removeNameField()
      Removes the field for the export name.
      Returns:
      this action for further customization

    • fileTypeField

      default A fileTypeField(List<SelectOption> optionsToAdd)
      Adds the field to select the file type that the export should ultimately produce for download by the user.
      Parameters:
      optionsToAdd - the list of SelectOption with the file types
      Returns:
      this action for further customization

    • fileTypeField

      default A fileTypeField(UnaryOperator<SelectField<?>> fn)
      Adds the field to select the file type that the export should ultimately produce for download by the user.
      Parameters:
      fn - the added field for further customization
      Returns:
      this action for further customization

    • addFileTypeField

      default A addFileTypeField(SelectField<?> field)
      Adds the field to select the file type that the export should ultimately produce for download by the user.
      Parameters:
      field - the added field for further customization
      Returns:
      this action for further customization

    • removeFileTypeField

      default A removeFileTypeField()
      Removes the field for the file type.
      Returns:
      this action for further customization

    • timeZoneField

      default A timeZoneField()
      Adds the select field to select the time-zone. This time zone is used to convert the dates.
      Returns:
      this action for further customization

    • timeZoneField

      default A timeZoneField(UnaryOperator<SelectField<?>> fn)
      Adds the select field to select the time-zone. This time zone is used to convert the dates.
      Parameters:
      fn - the added field for further customization
      Returns:
      this action for further customization

    • addTimeZoneField

      default A addTimeZoneField(SelectField<?> field)
      Adds the select field to select the time-zone. This time zone is used to convert the dates.
      Parameters:
      field - the added field for further customization
      Returns:
      this action for further customization

    • removeTimeZoneField

      default A removeTimeZoneField()
      Removes the select time-zone field.
      Returns:
      this action for further customization

    • downloadExportUri

      default A downloadExportUri(String uri)
      Adds the uri to download the export file by export id. To specify the export id use "${exportId}" e.g. "/export/${exportId}/download"
      Parameters:
      uri - the uri to download the export file.
      Returns:
      this action for further customization

    • passFilterStringAsParam

      default A passFilterStringAsParam(boolean passFilterStringAsParam)
      Whether the filter string to be used in the export grid action will be passed as a parameter or as part of the request body.
      Parameters:
      passFilterStringAsParam - whether to pass the filter as a parameter or in the request body
      Returns:
      this action for further customization