FetchGrid (Broadleaf Metadata Common 1.7.3-GA API)

All Superinterfaces:

Comparable<G>, Component<G>, Copyable<G>, Grid<G>, Serializable

All Known Subinterfaces:

EntityGridView<V>, ExportHistoryEntityGridView<V>, ExportHistoryGrid<G>, ExportHistoryGridExternal<E>, FilterableGrid<G>, GridExternal<E>, GridView<V>, ResidentGridField<F>, ResourceGrid<G>, SelectTargetEntityGridView<V>, SortableGrid<G>, TreeGridView<V>

All Known Implementing Classes:

DefaultEntityGridView, DefaultExportHistoryEntityGridView, DefaultExportHistoryGridExternal, DefaultGridExternal, DefaultResidentGridField, DefaultSelectTargetEntityGridView, DefaultTreeGridView
```
public interface FetchGrid<G extends FetchGrid<G>>
extends Grid<G>
```
Represents the metadata for a Grid that supports fetching it's own data.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class FetchGrid.EndpointTypes
- Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Grid
  Grid.Attributes, Grid.Keys

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default Optional<PageableEndpoint<?>>`	`findReadEndpoint()`
`default PageableEndpoint<?>`	`getReadEndpoint()`
`default String`	`getReadEndpointType()`
`default G`	`narrowedPaging()`
`default G`	`narrowedPaging(int pageSize)`
`default G`	`numberedPaging()`
`default G`	`numberedPaging(int pageSize)`
`default G`	`readEndpoint(PageableEndpoint<?> endpoint)`
`default G`	`readEndpoint(UnaryOperator<PageableEndpoint<?>> fn)`
`default G`	`readScope(String scope)`
`default G`	`readUrl(String url)`
`default G`	`readUrl(String url, String scope)`
`default G`	`unpaged()`

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component
addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable
copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Grid
addColumn, addColumn, addColumn, addColumns, findColumn, getColumn, idKey, removeColumn

Method Detail

readEndpoint

default G readEndpoint(PageableEndpoint<?> endpoint)

readEndpoint

default G readEndpoint(UnaryOperator<PageableEndpoint<?>> fn)

readUrl
```
default G readUrl(String url)
```

readScope
```
default G readScope(String scope)
```

readUrl

default G readUrl(String url,
                  String scope)

narrowedPaging
```
default G narrowedPaging()
```
See Also:

PageableEndpoint.narrowedPaging()

narrowedPaging
```
default G narrowedPaging(int pageSize)
```
See Also:

PageableEndpoint.narrowedPaging(int)

numberedPaging
```
default G numberedPaging()
```
See Also:

PageableEndpoint.numberedPaging()

numberedPaging
```
default G numberedPaging(int pageSize)
```
See Also:

PageableEndpoint.numberedPaging(int)

unpaged
```
default G unpaged()
```
See Also:

PageableEndpoint.unpaged()

getReadEndpoint

default PageableEndpoint<?> getReadEndpoint()

findReadEndpoint

default Optional<PageableEndpoint<?>> findReadEndpoint()

getReadEndpointType
```
default String getReadEndpointType()
```