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

Interface ResourceGrid<G extends ResourceGrid<G>>

All Superinterfaces:
ActionGrid<G>, Comparable<G>, Component<G>, Copyable<G>, FetchGrid<G>, Grid<G>, Serializable
All Known Subinterfaces:
ExportHistoryGridExternal<E>, GridExternal<E>
All Known Implementing Classes:
DefaultExportHistoryGridExternal, DefaultGridExternal
public interface ResourceGrid<G extends ResourceGrid<G>> extends ActionGrid<G>, FetchGrid<G>
Represents the metadata of a ActionGrid and FetchGrid that is used for managing an external resource. These types of grids support retrieving, creating, updating, and deleting the data for a collection.
Author:
Nick Crum (ncrum)

  • Method Details

    • addAssignAction

      default G addAssignAction(CreateModalFormAction<?> createAction)

    • assignAction

      default G assignAction(UnaryOperator<CreateModalFormAction<?>> fn)

    • assignLabel

      default G assignLabel(String labelKey)

    • getAssignAction

      default CreateModalFormAction<?> getAssignAction()

    • findAssignAction

      default Optional<CreateModalFormAction<?>> findAssignAction()

    • assignEndpoint

      default G assignEndpoint(Endpoint<?> endpoint)

    • assignEndpoint

      default G assignEndpoint(UnaryOperator<Endpoint<?>> fn)

    • assignUrl

      default G assignUrl(String url)

    • assignScope

      default G assignScope(String scope)

    • assignUrl

      default G assignUrl(String url, String scope)

    • getAssignEndpoint

      default Endpoint<?> getAssignEndpoint()

    • findAssignEndpoint

      default Optional<Endpoint<?>> findAssignEndpoint()

    • addCreateAction

      default G addCreateAction(CreateModalFormAction<?> createAction)

    • createAction

      default G createAction(UnaryOperator<CreateModalFormAction<?>> fn)

    • createLabel

      default G createLabel(String labelKey)

    • getCreateAction

      default CreateModalFormAction<?> getCreateAction()

    • findCreateAction

      default Optional<CreateModalFormAction<?>> findCreateAction()

    • createEndpoint

      default G createEndpoint(Endpoint<?> endpoint)

    • createEndpoint

      default G createEndpoint(UnaryOperator<Endpoint<?>> fn)

    • createUrl

      default G createUrl(String url)

    • createScope

      default G createScope(String scope)

    • createUrl

      default G createUrl(String url, String scope)

    • getCreateEndpoint

      default Endpoint<?> getCreateEndpoint()

    • findCreateEndpoint

      default Optional<Endpoint<?>> findCreateEndpoint()

    • addDeleteAction

      default G addDeleteAction(Action<?> deleteAction)

    • deleteAction

      default G deleteAction(UnaryOperator<Action<?>> fn)

    • deleteLabel

      default G deleteLabel(String labelKey)

    • getDeleteAction

      default Action<?> getDeleteAction()

    • findDeleteAction

      default Optional<Action<?>> findDeleteAction()

    • deleteEndpoint

      default G deleteEndpoint(Endpoint<?> endpoint)

    • deleteEndpoint

      default G deleteEndpoint(UnaryOperator<Endpoint<?>> fn)

    • deleteUrl

      default G deleteUrl(String url)

    • deleteScope

      default G deleteScope(String scope)

    • deleteUrl

      default G deleteUrl(String url, String scope)

    • getDeleteEndpoint

      default Endpoint<?> getDeleteEndpoint()

    • findDeleteEndpoint

      default Optional<Endpoint<?>> findDeleteEndpoint()

    • addUpdateAction

      default G addUpdateAction(ModalFormAction<?> updateAction)

    • updateAction

      default G updateAction(UnaryOperator<ModalFormAction<?>> fn)

    • updateLabel

      default G updateLabel(String labelKey)

    • getUpdateAction

      default ModalFormAction<?> getUpdateAction()

    • findUpdateAction

      default Optional<ModalFormAction<?>> findUpdateAction()

    • updateEndpoint

      default G updateEndpoint(Endpoint<?> endpoint)

    • updateEndpoint

      default G updateEndpoint(UnaryOperator<Endpoint<?>> fn)

    • updateUrl

      default G updateUrl(String url)

    • updateScope

      default G updateScope(String scope)

    • updateUrl

      default G updateUrl(String url, String scope)

    • getUpdateEndpoint

      default Endpoint<?> getUpdateEndpoint()

    • findUpdateEndpoint

      default Optional<Endpoint<?>> findUpdateEndpoint()

    • updateTranslationsEndpoint

      default G updateTranslationsEndpoint(Endpoint<?> endpoint)

    • updateTranslationsEndpoint

      default G updateTranslationsEndpoint(UnaryOperator<Endpoint<?>> fn)

    • updateTranslationsUrl

      default G updateTranslationsUrl(String url)

    • updateTranslationsScope

      default G updateTranslationsScope(String scope)

    • updateTranslationsUrl

      default G updateTranslationsUrl(String url, String scope)

    • getUpdateTranslationsEndpoint

      default Endpoint<?> getUpdateTranslationsEndpoint()

    • findUpdateTranslationsEndpoint

      default Optional<Endpoint<?>> findUpdateTranslationsEndpoint()

    • addViewReadOnlyAction

      default G addViewReadOnlyAction(FormAction<?> viewReadOnlyAction)
      Adds a ActionGrid.ActionPlacements.ROW action that allows a user to view the details of the row in a read-only form. This is generally used when a row is not editable yet there is a need to present the details of the row.
      Parameters:
      viewReadOnlyAction - the action to add
      Returns:
      this

    • viewReadOnlyAction

      default G viewReadOnlyAction(UnaryOperator<FormAction<?>> fn)
      Configure the ActionGrid.ActionPlacements.ROW action that allows a user to view the details of the row in a read-only form. This is generally used when a row is not editable yet there is a need to present the details of the row.
      Parameters:
      fn - a function to configure the read-only form
      Returns:
      this

    • viewReadOnlyLabel

      default G viewReadOnlyLabel(String labelKey)
      Shortcut for setting the label of the read-only action.
      Parameters:
      labelKey - the label or label message key
      Returns:
      this

    • getViewReadOnlyAction

      default FormAction<?> getViewReadOnlyAction()
      Returns:
      the read-only action if it exists

    • findViewReadOnlyAction

      default Optional<FormAction<?>> findViewReadOnlyAction()
      Returns:
      an optional with the read-only action, or empty

    • addRowFormAction

      default G addRowFormAction(String id, RowModalFormAction<?> rowFormAction)
      Adds a RowModalFormAction to the grid for submitting a modal form against an ad-hoc submission API. Action is created with placement ActionGrid.ActionPlacements.ROW and type ResourceGrid.ActionTypes.ROW_FORM.
      Parameters:
      id - the id to discriminate this row form action from siblings
      rowFormAction - the action to add
      Returns:
      this

    • rowFormAction

      default G rowFormAction(String id, UnaryOperator<RowModalFormAction<?>> fn)
      Configures a RowModalFormAction for the grid for submitting a modal form against an ad-hoc submission API. Action is created with placement ActionGrid.ActionPlacements.ROW and type ResourceGrid.ActionTypes.ROW_FORM.
      Parameters:
      id - the id to discriminate this row form action from siblings
      fn - the function for configuring the row form action
      Returns:
      this

    • getRowFormAction

      default RowModalFormAction<?> getRowFormAction(String id)
      Parameters:
      id - the id that discriminates this row form action from siblings
      Returns:
      the row form action if it exists

    • findRowFormAction

      default Optional<RowModalFormAction<?>> findRowFormAction(String id)
      Parameters:
      id - the id that discriminates this row form action from siblings
      Returns:
      an optional with the row form action, or empty