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

Interface EntityGridView<V extends EntityGridView<V>>

All Superinterfaces:
ActionGrid<V>, ActionView<V>, Comparable<V>, Component<V>, Copyable<V>, CustomCssComponent<V>, ExportGrid<V>, FetchGrid<V>, Filterable<V>, FilterableGrid<V>, Grid<V>, GridView<V>, ImportGrid<V>, Pollable<V>, Selectable<V>, Serializable, SortableGrid<V>, TileGrid<V>, Trackable<V>, View<V>
All Known Subinterfaces:
ExportHistoryEntityGridView<V>
All Known Implementing Classes:
DefaultEntityGridView, DefaultExportHistoryEntityGridView
public interface EntityGridView<V extends EntityGridView<V>> extends ActionView<V>, GridView<V>, Trackable<V>, ImportGrid<V>, ExportGrid<V>, TileGrid<V>
Author:
Nick Crum (ncrum)

  • Method Details

    • addCreateAction

      default V addCreateAction(LinkAction<?> action)

    • createAction

      default V createAction(UnaryOperator<LinkAction<?>> fn)

    • createLink

      default V createLink(Link createLink)

    • createLinkById

      default V createLinkById(String componentId)

    • createLabel

      default V createLabel(InternationalizedMessage label)

    • createLabel

      default V createLabel(String label)

    • createScope

      default V createScope(String scope)

    • getCreateAction

      default LinkAction<?> getCreateAction()

    • findCreateAction

      default Optional<LinkAction<?>> findCreateAction()

    • addCloneAction

      default V addCloneAction(CloneModalFormAction<?> action)
      Configures this grid with a row-level action that provides the ability to "clone" the entity. The use of this action will result in a modal form being provided with any fields configured on the action. This form is typically used so that a user has the opportunity to change up a limited set of properties on the cloned entity.
      Parameters:
      action - the clone action
      Returns:
      this

    • cloneAction

      default V cloneAction(UnaryOperator<CloneModalFormAction<?>> fn)
      Configures this grid with a row-level action that provides the ability to "clone" the entity. The use of this action will result in a modal form being provided with any fields configured on the action. This form is typically used so that a user has the opportunity to change up a limited set of properties on the cloned entity.
      Parameters:
      fn - a function that configures the action
      Returns:
      this

    • getCloneAction

      default CloneModalFormAction<?> getCloneAction()
      Returns the clone action on this grid.
      Returns:
      the clone action, if it exists

    • findCloneAction

      default Optional<CloneModalFormAction<?>> findCloneAction()
      Finds the clone action on this grid.
      Returns:
      an optional with the clone action, if it exists, or empty

    • tenantOnly

      default V tenantOnly()
      Indicates that this grid should only be rendered in tenant contexts, not applications.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • notTenantOnly

      default V notTenantOnly()
      Clears the tenant-only attribute, indicating that this grid can be rendered in both tenant and application contexts.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • tenantOnly

      default V tenantOnly(boolean tenantOnly)
      Indicates that this grid should only be rendered in tenant contexts, not applications.
      Parameters:
      tenantOnly - if true, the grid will only be rendered in tenant contexts and not in application contexts.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • applicationOnly

      default V applicationOnly()
      Indicates that this grid should only be rendered in application contexts, not tenants.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • notApplicationOnly

      default V notApplicationOnly()
      Clears the application-only attribute, indicating that this grid can be rendered in both tenant and application contexts.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • applicationOnly

      default V applicationOnly(boolean applicationOnly)
      Indicates that this grid should only be rendered in application contexts, not tenants.
      Parameters:
      applicationOnly - if true, the grid will only be rendered in application contexts and not in tenant contexts.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • restrictedApplications

      default V restrictedApplications(String... applicationIds)
      Indicates that this grid should only be displayed when in specific application contexts.
      Parameters:
      applicationIds - the application IDs that this grid should be restricted to.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • restrictedApplications

      default V restrictedApplications(Iterable<String> applicationIds)
      Indicates that this grid should only be displayed when in specific application contexts.
      Parameters:
      applicationIds - the application IDs that this grid should be restricted to.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5

    • clearRestrictedApplications

      default V clearRestrictedApplications()
      Clears the restricted applications attribute, indicating that this grid can be rendered in all application contexts.
      Returns:
      this
      Since:
      Metadata 2.0.7, Release Train 2.1.5