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

Interface AugmentableView<V extends AugmentableView<V>>

All Superinterfaces:

Comparable<V>, Component<V>, Copyable<V>, Serializable, View<V>

All Known Subinterfaces:

CreateEntityView<V>, CreateModalFormView<V>, EntityView<V>, TreeView<V>, UpdateEntityView<V>, UpdateModalFormView<V>

All Known Implementing Classes:

DefaultCreateEntityLongFormView, DefaultCreateEntityView, DefaultCreateModalFormView, DefaultTreeView, DefaultUpdateEntityLongFormView, DefaultUpdateEntityView, DefaultUpdateModalFormView

public interface AugmentableView<V extends AugmentableView<V>>
extends View<V>

An Augmentable View is a type of View that can be augmented with additional fields dynamically rather than strictly through the static metadata definition.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AugmentableView.Attributes

Method Summary

Modifier and Type	Method	Description
default V	complexAttributes()	The complexAttributes attribute specifies that a View contains complex values
default V	complexAttributes(boolean isComplex)	The complexAttributes attribute specifies whether a View contains complex values or not
default V	displayShowInQueryBuilder()	The displayShowInQueryBuilder attribute specifies that a View's augmentation form allows the option to show the augmentation in query builders
default V	displayShowInQueryBuilder(boolean display)	The displayShowInQueryBuilder attribute specifies whether a View's augmentation form allows the option to show the augmentation in query builders or not
default V	notComplexAttributes()	The complexAttributes attribute specifies that a View does not complex values

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, addSimpleComponent, apply, attribute, augmentable, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentableFlag, 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, setAugmentable, 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

Method Details

complexAttributes

default V complexAttributes()

The complexAttributes attribute specifies that a View contains complex values

Returns:

this view for further customization

complexAttributes

default V complexAttributes(boolean isComplex)

The complexAttributes attribute specifies whether a View contains complex values or not

Parameters:

isComplex - boolean value that states whether the values are complex or not

Returns:

this field for further customization

notComplexAttributes

default V notComplexAttributes()

The complexAttributes attribute specifies that a View does not complex values

Returns:

this field for further customization

displayShowInQueryBuilder

default V displayShowInQueryBuilder()

The displayShowInQueryBuilder attribute specifies that a View's augmentation form allows the option to show the augmentation in query builders

Returns:

this view for further customization

displayShowInQueryBuilder

default V displayShowInQueryBuilder(boolean display)

The displayShowInQueryBuilder attribute specifies whether a View's augmentation form allows the option to show the augmentation in query builders or not

Parameters:

display - boolean value that states whether the option should be displayed or not

Returns:

this view for further customization