Interface CreateEntityView<V extends CreateEntityView<V>>
-
- All Superinterfaces:
ActionView<V>
,AugmentableView<V>
,Comparable<V>
,Component<V>
,Copyable<V>
,EntityView<V>
,Serializable
,Trackable<V>
,View<V>
- All Known Implementing Classes:
DefaultCreateEntityLongFormView
,DefaultCreateEntityView
public interface CreateEntityView<V extends CreateEntityView<V>> extends EntityView<V>
- Author:
- Nick Crum (ncrum)
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
CreateEntityView.ActionTypes
static class
CreateEntityView.Attributes
static class
CreateEntityView.EndpointTypes
-
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.ActionView
ActionView.ActionKeys, ActionView.ActionPlacements
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default V
addSubmitAction(Action<?> action)
default Optional<Action<?>>
findSubmitAction()
default Action<?>
getSubmitAction()
default Endpoint<?>
getSubmitEndpoint()
default V
redirectToBackOnCreate()
Configure this create view to redirect back rather than to the update view after a successful create request.default V
redirectToUpdateOnCreate()
Configure this create view to redirect to the update view.default V
submitAction(Action<?> action)
default V
submitAction(UnaryOperator<Action<?>> fn)
default V
submitEndpoint(Endpoint<?> endpoint)
default V
submitEndpoint(UnaryOperator<Endpoint<?>> fn)
default V
submitLabel(InternationalizedMessage label)
default V
submitLabel(String label)
default V
submitScope(String scope)
default V
submitUrl(String url)
default V
submitUrl(String url, String scope)
default V
updateLink(Link link)
Configures the link to the update view so that on a successful create the user will be redirected to the newly created item's update view.default V
updateLinkById(String componentId)
Configures the link by ID to the update view so that on a successful create the user will be redirected to the newly created item's update view.default V
updateLinkByPath(String path)
Configures the link by path to the update view so that on a successful create the user will be redirected to the newly created item's update view.-
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.extension.views.details.EntityView
addForm, addGeneralForm, backLink, backLinkById, backLinkByPath, findForm, form, generalForm, getForm, getGeneralForm
-
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable
catalogTrackable, notCatalogTrackable, notProfileTrackable, notSandboxTrackable, profileTrackable, sandboxTrackable
-
-
-
-
Method Detail
-
redirectToBackOnCreate
default V redirectToBackOnCreate()
Configure this create view to redirect back rather than to the update view after a successful create request. This is typically used by views that either do not have an update view, or may not have an update view available for some time.- Returns:
- this
-
redirectToUpdateOnCreate
default V redirectToUpdateOnCreate()
Configure this create view to redirect to the update view. This is the default behavior, and this method is typically only used when modifying an existing view that already usedredirectToBackOnCreate()
- Returns:
- this
-
updateLink
default V updateLink(Link link)
Configures the link to the update view so that on a successful create the user will be redirected to the newly created item's update view.- Parameters:
link
- the link to the update view- Returns:
- this
-
updateLinkById
default V updateLinkById(String componentId)
Configures the link by ID to the update view so that on a successful create the user will be redirected to the newly created item's update view.- Parameters:
componentId
- the componentId of the update view's route- Returns:
- this
-
updateLinkByPath
default V updateLinkByPath(String path)
Configures the link by path to the update view so that on a successful create the user will be redirected to the newly created item's update view.- Parameters:
path
- the path to the update view- Returns:
- this
-
submitAction
default V submitAction(UnaryOperator<Action<?>> fn)
-
getSubmitAction
default Action<?> getSubmitAction()
-
submitLabel
default V submitLabel(InternationalizedMessage label)
-
submitEndpoint
default V submitEndpoint(UnaryOperator<Endpoint<?>> fn)
-
getSubmitEndpoint
default Endpoint<?> getSubmitEndpoint()
-
-