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

Interface EntityModalFormAction<A extends EntityModalFormAction<A>>

All Superinterfaces:

Action<A>, Comparable<A>, ConditionalAction<A>, Copyable<A>, FormAction<A>, ModalFormAction<A>, Serializable

All Known Implementing Classes:

DefaultEntityModalFormAction

public interface EntityModalFormAction<A extends EntityModalFormAction<A>>
extends ModalFormAction<A>

A variation of the basic ModalFormAction that allows specifying an endpoint to submit the form to.

Since:

2.x.x

Author:

Nathan Moore (nathandmoore)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EntityModalFormAction.Attributes
static final class	EntityModalFormAction.EndpointTypes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.FormAction

FormAction.Keys

Method Summary

Modifier and Type	Method	Description
default A	addSubmitEndpoint(Endpoint<?> endpoint)	Adds the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for the component.
default Optional<Endpoint<?>>	findSubmitEndpoint()	Finds the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for this component.
default Endpoint<?>	getSubmitEndpoint()	Retrieves the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for this component.
default A	notRefreshOnMount()	Indicate this action should not trigger a refresh of the parent EntityView after a successful submission.
default A	refreshOnMount()	Indicate this action should trigger a refresh of the parent EntityView after a successful submission.
default A	submitEndpoint(UnaryOperator<Endpoint<?>> fn)	Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for the component.
default A	submitScope(String scope)	Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint with the given scope.
default A	submitUrl(String url)	Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint with the given url.
default A	submitUrl(String url, String scope)	Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint with the given url and scope.
default A	transform(Mapping<?>... mappings)	Configure a set of Mapping to transform the d entity.
default A	transform(UnaryOperator<List<Mapping<?>>> fn)	Configure a set of Mapping to transform the form state.
default A	transform(List<Mapping<?>> mappings)	Configure a set of Mapping to transform the form state.
default A	unsetRefreshOnMount()	Undo a previous call to refreshOnMount() or notRefreshOnMount().

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

addComponent, addComponents, addEndpoint, addEndpoint, apply, attribute, clearEndpoints, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAttribute, getAttribute, getAttributes, getComponent, getComponent, getComponents, getComponentsList, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOperationType, getOrder, getPlacement, getScope, getType, hasAttribute, hasComponent, hasEndpoint, id, label, label, operationType, order, placement, removeAttribute, removeComponent, removeEndpoint, scope, self, setAttributes, setComponents, setEndpoints, setId, setLabel, setOperationType, setOrder, setPlacement, setScope, setType, type

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.ConditionalAction

conditional, conditional

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

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.FormAction

addExternal, addExternal, addField, addField, addField, addFormComponents, addGroup, addGroup, external, field, findExternal, findField, findGroup, getExternal, getField, getGroup, group, removeExternal, removeField, removeGroup

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.ModalFormAction

modalSize, submitLabel, submitLabel

Method Details

addSubmitEndpoint

default A addSubmitEndpoint(Endpoint<?> endpoint)

Adds the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for the component.

Parameters:

endpoint - the endpoint

Returns:

this

submitEndpoint

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

Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for the component.

Parameters:

fn - the function to configure the endpoint

Returns:

this

submitUrl

default A submitUrl(String url)

Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint with the given url.

Parameters:

url - the url

Returns:

this

submitScope

default A submitScope(String scope)

Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint with the given scope.

Parameters:

scope - the scope

Returns:

this

submitUrl

default A submitUrl(String url,
 String scope)

Configures the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint with the given url and scope.

Parameters:

url - the url

scope - the scope

Returns:

this

getSubmitEndpoint

default Endpoint<?> getSubmitEndpoint()

Retrieves the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for this component.

Returns:

the endpoint if it exists

See Also:

• for null-safe operation

findSubmitEndpoint

default Optional<Endpoint<?>> findSubmitEndpoint()

Finds the EntityModalFormAction.EndpointTypes.SUBMIT_FORM endpoint for this component.

Returns:

an optional with the endpoint, or empty

transform

default A transform(Mapping<?>... mappings)

Configure a set of Mapping to transform the d entity.

A common use case is to transform the name of an entity, for example:

 Action.transform(Mappings.templateTransform("name", " of ${name}"));
 

Returns:

this

transform

default A transform(List<Mapping<?>> mappings)

Configure a set of Mapping to transform the form state.

A common use case is to transform the name of an entity, for example:

 Action.transform(Arrays.asList(Mappings.templateTransform("name", " of ${name}")));
 

Returns:

this

transform

default A transform(UnaryOperator<List<Mapping<?>>> fn)

Configure a set of Mapping to transform the form state.

A common use case is to transform the name of an entity, for example:

 Action.transform(
         mappings -> mappings.add(Mappings.templateTransform("name", " of ${name}")));
 

Returns:

this

refreshOnMount

default A refreshOnMount()

Indicate this action should trigger a refresh of the parent EntityView after a successful submission.

Returns:

this

notRefreshOnMount

default A notRefreshOnMount()

Indicate this action should not trigger a refresh of the parent EntityView after a successful submission.

Returns:

this

unsetRefreshOnMount

default A unsetRefreshOnMount()

Undo a previous call to refreshOnMount() or notRefreshOnMount().

Returns:

this