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

Interface AddAdjustmentModalFormAction<A extends AddAdjustmentModalFormAction<A>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultAddAdjustmentModalFormAction

public interface AddAdjustmentModalFormAction<A extends AddAdjustmentModalFormAction<A>>
extends ModalFormAction<A>

Extension of ModalFormAction that is used to apply an offer to the entity.

Author:

Julia Lopez-Pozas (juliap)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AddAdjustmentModalFormAction.Attributes
static final class	AddAdjustmentModalFormAction.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	addAddAdjustmentEndpoint(Endpoint<?> endpoint)	Adds the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for the component.
default A	addAdjustmentEndpoint(UnaryOperator<Endpoint<?>> fn)	Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for the component.
default A	addAdjustmentScope(String scope)	Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint with the given scope.
default A	addAdjustmentUrl(String url)	Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint with the given url.
default A	addAdjustmentUrl(String url, String scope)	Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint with the given url and scope.
default Optional<Endpoint<?>>	findAddAdjustmentEndpoint()	Finds the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for this component.
default Endpoint<?>	getAddAdjustmentEndpoint()	Retrieves the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for this component.
default A	redirectLink(Link link)	Defines a redirect to occur following a successful application of the offer.
default A	redirectLinkById(String componentId)	Defines a redirect to occur following a successful application of the offer.
default A	redirectLinkByPath(String path)	Defines a redirect to occur following a successful application of the offer.

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

addAddAdjustmentEndpoint

default A addAddAdjustmentEndpoint(Endpoint<?> endpoint)

Adds the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for the component.

Parameters:

endpoint - the endpoint

Returns:

this

addAdjustmentEndpoint

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

Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for the component.

Parameters:

fn - the function to configure the endpoint

Returns:

this

addAdjustmentUrl

default A addAdjustmentUrl(String url)

Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint with the given url.

Parameters:

url - the url

Returns:

this

addAdjustmentScope

default A addAdjustmentScope(String scope)

Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint with the given scope.

Parameters:

scope - the scope

Returns:

this

addAdjustmentUrl

default A addAdjustmentUrl(String url,
 String scope)

Configures the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint with the given url and scope.

Parameters:

url - the url

scope - the scope

Returns:

this

getAddAdjustmentEndpoint

default Endpoint<?> getAddAdjustmentEndpoint()

Retrieves the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for this component.

Returns:

the endpoint if it exists

See Also:

• for null-safe operation

findAddAdjustmentEndpoint

default Optional<Endpoint<?>> findAddAdjustmentEndpoint()

Finds the AddAdjustmentModalFormAction.EndpointTypes.ADD_ADJUSTMENT endpoint for this component.

Returns:

an optional with the endpoint, or empty

redirectLink

default A redirectLink(Link link)

Defines a redirect to occur following a successful application of the offer.

Parameters:

link - the link to redirect to

Returns:

this

redirectLinkByPath

default A redirectLinkByPath(String path)

Defines a redirect to occur following a successful application of the offer.

Parameters:

path - the path to redirect to

Returns:

this

redirectLinkById

default A redirectLinkById(String componentId)

Defines a redirect to occur following a successful application of the offer.

Parameters:

componentId - the id of the component to redirect to

Returns:

this