Interface EntityGridView<V extends EntityGridView<V>>
-
- All Superinterfaces:
ActionGrid<V>
,ActionView<V>
,Comparable<V>
,Component<V>
,Copyable<V>
,ExportGrid<V>
,FetchGrid<V>
,Filterable<V>
,FilterableGrid<V>
,Grid<V>
,GridView<V>
,ImportGrid<V>
,Pollable<V>
,Selectable<V>
,Serializable
,SortableGrid<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>
- Author:
- Nick Crum (ncrum)
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
EntityGridView.ActionTypes
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ActionGrid
ActionGrid.ActionKeys, ActionGrid.ActionPlacements
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.ActionView
ActionView.ActionKeys, ActionView.ActionPlacements
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FetchGrid
FetchGrid.EndpointTypes
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Filterable
Filterable.Attributes
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FilterableGrid
FilterableGrid.ActionKeys, FilterableGrid.FilterKeys, FilterableGrid.FilterParams, FilterableGrid.FilterPlacements, FilterableGrid.FilterTypes
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Grid
Grid.Attributes, Grid.Keys
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Pollable
Pollable.Attributes
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Selectable
Selectable.Attributes, Selectable.ConfigureSelectable, Selectable.SelectableTypes
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.SortableGrid
SortableGrid.Attributes, SortableGrid.Sort
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable
Trackable.Attributes
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default V
addCloneAction(CloneModalFormAction<?> action)
Configures this grid with a row-level action that provides the ability to "clone" the entity.default V
addCreateAction(LinkAction<?> action)
default V
cloneAction(UnaryOperator<CloneModalFormAction<?>> fn)
Configures this grid with a row-level action that provides the ability to "clone" the entity.default V
createAction(UnaryOperator<LinkAction<?>> fn)
default V
createLabel(InternationalizedMessage label)
default V
createLabel(String label)
default V
createLink(Link createLink)
default V
createLinkById(String componentId)
default V
createScope(String scope)
default Optional<CloneModalFormAction<?>>
findCloneAction()
Finds the clone action on this grid.default Optional<LinkAction<?>>
findCreateAction()
default CloneModalFormAction<?>
getCloneAction()
Returns the clone action on this grid.default LinkAction<?>
getCreateAction()
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ActionGrid
addGridAction, addGridAction, addRowAction, addRowAction, findGridAction, findRowAction, getGridAction, getRowAction, gridAction, removeGridAction, removeRowAction, rowAction
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.ActionView
addPrimaryAction, addPrimaryAction, addSecondaryAction, addSecondaryAction, findPrimaryAction, findSecondaryAction, getPrimaryAction, getSecondaryAction, primaryAction, primaryAction, secondaryAction, secondaryAction
-
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.extension.ExportGrid
addExportGridAction, exportGridAction, removeExportGridAction
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FetchGrid
findReadEndpoint, getReadEndpoint, getReadEndpointType, narrowedPaging, narrowedPaging, numberedPaging, numberedPaging, readEndpoint, readEndpoint, readScope, readUrl, readUrl, unpaged
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Filterable
implicitFilter, implicitFilters, implicitFilters
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FilterableGrid
addAdvancedFilter, addInlineFilter, addQueryFilter, filterByLookup, filterByQueryBuilder, filterByQueryBuilder, filterByQueryBuilder, filterByQueryBuilder, filterByTextQuery, filterByTextQuery, filterByTextQuery, filterByTextQuery, findAdvancedFilter, findFilterByLookupFilterAction, findFilterByQueryBuilderAction, findFilterByTextQueryAction, findInlineFilter, findQueryFilter, getAdvancedFilter, getFilterByLookupFilterAction, getFilterByQueryBuilderAction, getFilterByTextQueryAction, getInlineFilter, getQueryFilter, notFilterByQueryBuilder, notFilterByQueryBuilder, notFilterByTextQuery, notFilterByTextQuery, removeAdvancedFilter, removeInlineFilter, removeQueryFilter
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Grid
addColumn, addColumn, addColumn, addColumns, findColumn, getColumn, idKey, removeColumn
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ImportGrid
addImportGridAction, importGridAction, importGridAction, removeImportGridAction
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Pollable
notPollable, pollable, pollable, pollable, pollableCollectionCondition, pollableCollectionConditions, pollableItemCondition, pollableItemConditions, pollableOptions, pollableOptions
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Selectable
multiPageSelectable, multiPageSelectableWithExclusions, multipleSelectable, notSelectable, selectable, selectable, selectable, selectableType, singleSelectable
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.SortableGrid
notSortable, notSortable, sortable, sortable, sortableWithDefault, sortableWithDefault
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable
catalogTrackable, notCatalogTrackable, notProfileTrackable, notSandboxTrackable, profileTrackable, sandboxTrackable
-
-
-
-
Method Detail
-
addCreateAction
default V addCreateAction(LinkAction<?> action)
-
createAction
default V createAction(UnaryOperator<LinkAction<?>> fn)
-
createLabel
default V createLabel(InternationalizedMessage label)
-
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
-
-