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

Interface Trackable<T extends Trackable<T>>

All Superinterfaces:

Comparable<T>, Component<T>, Copyable<T>, Serializable

All Known Subinterfaces:

CreateEntityView<V>, EntityGridView<V>, EntityView<V>, ExportHistoryEntityGridView<V>, ExportHistoryGridExternal<E>, GridExternal<E>, LookupField<F>, PreviewableView<V>, SelectTargetEntityGridView<V>, TreeExternal<E>, TreeView<V>, UpdateEntityView<V>

All Known Implementing Classes:

DefaultCreateEntityLongFormView, DefaultCreateEntityView, DefaultEntityGridView, DefaultExportHistoryEntityGridView, DefaultExportHistoryGridExternal, DefaultGridExternal, DefaultLookupField, DefaultSelectTargetEntityGridView, DefaultTreeExternal, DefaultTreeView, DefaultUpdateEntityLongFormView, DefaultUpdateEntityView

public interface Trackable<T extends Trackable<T>>
extends Component<T>

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Trackable.Attributes

Method Summary

Modifier and Type	Method	Description
default T	applicationTrackable()	Enables application trackable behavior for the component.
default T	applicationTrackable(boolean applicationDiscriminated)	Optionally enables application trackable behavior for the component.
default T	auditable()	Enables auditable behavior for the component.
default T	auditable(String entityAlias)	Enables auditable behavior for the component and creates an entity alias attribute.
default T	catalogTrackable()	Enables catalog trackable behavior for the component.
default T	notAuditable()	Disabled auditable behavior for the component.
default T	notCatalogTrackable()	Disabled catalog trackable behavior for the component.
default T	notProfileTrackable()	Disabled profile trackable behavior for the component.
default T	notSandboxTrackable()	Disables sandbox trackable behavior for the component.
default T	notSearchGroupTrackable()	Disabled search group trackable behavior for the component.
default T	profileTrackable()	Enables profile trackable behavior for the component.
default T	sandboxTrackable(String changeContainerName)	Enables sandbox trackable behavior for the component.
default T	searchGroupTrackable()	Enables search group trackable behavior for the component.

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

Method Details

applicationTrackable

default T applicationTrackable()

Enables application trackable behavior for the component. This is typically not needed.

applicationTrackable

default T applicationTrackable(boolean applicationDiscriminated)

Optionally enables application trackable behavior for the component.

catalogTrackable

default T catalogTrackable()

Enables catalog trackable behavior for the component.

notCatalogTrackable

default T notCatalogTrackable()

Disabled catalog trackable behavior for the component.

profileTrackable

default T profileTrackable()

Enables profile trackable behavior for the component.

Note that "profile" is a type of Catalog under the hood, but they are distinct from the Admin's perspective.

notProfileTrackable

default T notProfileTrackable()

Disabled profile trackable behavior for the component.

Note that "profile" is a type of Catalog under the hood, but they are distinct from the Admin's perspective.

searchGroupTrackable

default T searchGroupTrackable()

Enables search group trackable behavior for the component.

Note that "search group" is a type of Catalog under the hood, but they are distinct from the Admin's perspective.

notSearchGroupTrackable

default T notSearchGroupTrackable()

Disabled search group trackable behavior for the component.

Note that "search group" is a type of Catalog under the hood, but they are distinct from the Admin's perspective.

auditable

default T auditable()

Enables auditable behavior for the component.

auditable

default T auditable(String entityAlias)

Enables auditable behavior for the component and creates an entity alias attribute.

notAuditable

default T notAuditable()

Disabled auditable behavior for the component.

sandboxTrackable

default T sandboxTrackable(String changeContainerName)

Enables sandbox trackable behavior for the component.

Parameters:

changeContainerName - the name of the change container, e.g. PRODUCT

Returns:

the trackable

notSandboxTrackable

default T notSandboxTrackable()

Disables sandbox trackable behavior for the component.