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

Interface UpdateEntityView<V extends UpdateEntityView<V>>

All Superinterfaces:

ActionView<V>, AugmentableView<V>, Comparable<V>, Component<V>, Copyable<V>, EntityView<V>, FetchEntity<V>, PreviewableView<V>, Serializable, Trackable<V>, View<V>

All Known Implementing Classes:

DefaultUpdateEntityLongFormView, DefaultUpdateEntityView

public interface UpdateEntityView<V extends UpdateEntityView<V>>
extends EntityView<V>, FetchEntity<V>, PreviewableView<V>

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UpdateEntityView.ActionTypes
static class	UpdateEntityView.Attributes
static class	UpdateEntityView.EndpointTypes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.ActionView

ActionView.ActionKeys, ActionView.ActionPlacements

Method Summary

Modifier and Type	Method	Description
default V	addCloneAction(CloneModalFormAction<?> action)
default V	addDeleteAction(Action<?> action)
default V	addDeleteEndpoint(Endpoint<?> endpoint)
default V	addSubmitAction(Action<?> action)
default V	addSubmitEndpoint(Endpoint<?> endpoint)
default V	addSubmitTranslationsEndpoint(Endpoint<?> endpoint)
default V	cloneAction(UnaryOperator<CloneModalFormAction<?>> fn)
default V	deleteAction(Action<?> action)
default V	deleteAction(UnaryOperator<Action<?>> fn)
default V	deleteEndpoint(UnaryOperator<Endpoint<?>> fn)
default V	deleteLabel(InternationalizedMessage label)
default V	deleteLabel(String label)
default V	deleteScope(String scope)
default V	deleteUrl(String url)
default V	deleteUrl(String url, String scope)
default V	displayNameKey(String displayNameKey)
default V	exportHistoryGrid(UnaryOperator<ExportHistoryGridExternal<?>> fn)	Adds the export history grid.
default Optional<CloneModalFormAction<?>>	findCloneAction()
default Optional<Action<?>>	findDeleteAction()
default Optional<ExportHistoryGridExternal<?>>	findExportHistoryGrid()	Search the export history grid view.
default Optional<Action<?>>	findSubmitAction()
default CloneModalFormAction<?>	getCloneAction()
default Action<?>	getDeleteAction()
default Endpoint<?>	getDeleteEndpoint()
default ExportHistoryGridExternal<?>	getExportHistoryGrid()	Returns the ExportHistoryGridExternal if it exists.
default Action<?>	getSubmitAction()
default Endpoint<?>	getSubmitEndpoint()
default Endpoint<?>	getUpdateTranslationsEndpoint()
default V	removeExportHistoryGrid()	Removes the export history grid.
default V	submitAction(Action<?> action)
default V	submitAction(UnaryOperator<Action<?>> fn)
default V	submitEndpoint(UnaryOperator<Endpoint<?>> fn)
default V	submitLabel(InternationalizedMessage label)
default V	submitLabel(String label)
default V	submitScope(String scope)
default V	submitTranslationsEndpoint(UnaryOperator<Endpoint<?>> fn)
default V	submitTranslationsScope(String scope)
default V	submitTranslationsUrl(String url)
default V	submitTranslationsUrl(String url, String scope)
default V	submitUrl(String url)
default V	submitUrl(String url, String scope)

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 com.broadleafcommerce.metadata.dsl.core.extension.views.AugmentableView

complexAttributes, complexAttributes, notComplexAttributes

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.views.details.EntityView

addForm, addGeneralForm, backLink, backLinkById, backLinkByPath, findForm, form, generalForm, getForm, getGeneralForm

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FetchEntity

addReadEndpoint, findReadEndpoint, getReadEndpoint, readEndpoint, readScope, readUrl, readUrl

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.PreviewableView

previewPath, removePreviewPath

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable

catalogTrackable, notCatalogTrackable, notProfileTrackable, notSandboxTrackable, profileTrackable, sandboxTrackable

Method Detail

displayNameKey

default V displayNameKey(String displayNameKey)

addSubmitAction

default V addSubmitAction(Action<?> action)

submitAction

default V submitAction(Action<?> action)

submitAction

default V submitAction(UnaryOperator<Action<?>> fn)

getSubmitAction

default Action<?> getSubmitAction()

findSubmitAction

default Optional<Action<?>> findSubmitAction()

submitLabel

default V submitLabel(InternationalizedMessage label)

submitLabel

default V submitLabel(String label)

addSubmitEndpoint

default V addSubmitEndpoint(Endpoint<?> endpoint)

submitEndpoint

default V submitEndpoint(UnaryOperator<Endpoint<?>> fn)

submitUrl

default V submitUrl(String url)

submitScope

default V submitScope(String scope)

submitUrl

default V submitUrl(String url,
                    String scope)

getSubmitEndpoint

default Endpoint<?> getSubmitEndpoint()

addDeleteAction

default V addDeleteAction(Action<?> action)

deleteAction

default V deleteAction(Action<?> action)

deleteAction

default V deleteAction(UnaryOperator<Action<?>> fn)

getDeleteAction

default Action<?> getDeleteAction()

findDeleteAction

default Optional<Action<?>> findDeleteAction()

deleteLabel

default V deleteLabel(InternationalizedMessage label)

deleteLabel

default V deleteLabel(String label)

addDeleteEndpoint

default V addDeleteEndpoint(Endpoint<?> endpoint)

deleteEndpoint

default V deleteEndpoint(UnaryOperator<Endpoint<?>> fn)

getDeleteEndpoint

default Endpoint<?> getDeleteEndpoint()

deleteUrl

default V deleteUrl(String url)

deleteScope

default V deleteScope(String scope)

deleteUrl

default V deleteUrl(String url,
                    String scope)

addCloneAction

default V addCloneAction(CloneModalFormAction<?> action)

cloneAction

default V cloneAction(UnaryOperator<CloneModalFormAction<?>> fn)

getCloneAction

default CloneModalFormAction<?> getCloneAction()

findCloneAction

default Optional<CloneModalFormAction<?>> findCloneAction()

addSubmitTranslationsEndpoint

default V addSubmitTranslationsEndpoint(Endpoint<?> endpoint)

submitTranslationsEndpoint

default V submitTranslationsEndpoint(UnaryOperator<Endpoint<?>> fn)

getUpdateTranslationsEndpoint

default Endpoint<?> getUpdateTranslationsEndpoint()

submitTranslationsUrl

default V submitTranslationsUrl(String url)

submitTranslationsScope

default V submitTranslationsScope(String scope)

submitTranslationsUrl

default V submitTranslationsUrl(String url,
                                String scope)

exportHistoryGrid

default V exportHistoryGrid(UnaryOperator<ExportHistoryGridExternal<?>> fn)

Adds the export history grid.

Parameters:

fn - the added ExportHistoryGrid for further customization

Returns:

this view for further customization

removeExportHistoryGrid

default V removeExportHistoryGrid()

Removes the export history grid.

Returns:

this view for further customization

findExportHistoryGrid

default Optional<ExportHistoryGridExternal<?>> findExportHistoryGrid()

Search the export history grid view.

Returns:

the found ExportHistoryGridExternal

getExportHistoryGrid

default ExportHistoryGridExternal<?> getExportHistoryGrid()

Returns the ExportHistoryGridExternal if it exists.

Returns:

the found ExportHistoryGridExternal

Throws:

IllegalArgumentException - if there is no grid for export history