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

Interface PreviewableView<V extends PreviewableView<V>>

All Superinterfaces:

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

All Known Subinterfaces:

TreeView<V>, UpdateEntityView<V>

All Known Implementing Classes:

DefaultTreeView, DefaultUpdateEntityLongFormView, DefaultUpdateEntityView

public interface PreviewableView<V extends PreviewableView<V>>
extends Trackable<V>, View<V>

Represents the metadata for a trackable view that supports previewing sandbox data.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PreviewableView.Attributes

Method Summary

Modifier and Type	Method	Description
default V	previewPath(String previewPathTemplate)	Configures this view to support previewing sandbox data at the provided path.
default V	removePreviewPath()	If the preview path was set, this will remove it.

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, findAttribute, findComponent, findComponent, findComponents, findEndpoint, 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.Trackable

applicationTrackable, applicationTrackable, auditable, auditable, catalogTrackable, notAuditable, notCatalogTrackable, notProfileTrackable, notSandboxTrackable, notSearchGroupTrackable, profileTrackable, sandboxTrackable, searchGroupTrackable

Method Details

previewPath

default V previewPath(String previewPathTemplate)

Configures this view to support previewing sandbox data at the provided path. This method will configure this view to redirect to the application given the provided preview path template.

Supports a template URL path, for example: "/products/${id}"

Parameters:

previewPathTemplate - the template preview path string

Returns:

this

removePreviewPath

default V removePreviewPath()

If the preview path was set, this will remove it.

Returns:

this