Package com.broadleafcommerce.metadata.dsl.core

Interface Action<A extends Action<A>>

All Superinterfaces:

Comparable<A>, Copyable<A>, Serializable

All Known Subinterfaces:

ActionGroup<A>, AddAdjustmentModalFormAction<A>, BulkOperationAction<A>, CloneModalFormAction<A>, ConditionalAction<A>, CreateModalFormAction<A>, EntityModalFormAction<A>, ExportGridAction<A>, FilterAction<A>, FormAction<A>, GenerateTemplateAction<A>, GridRowConditionalAction<A>, ImportGridAction<A>, InlineGridSelectAction<A>, LinkAction<A>, LookupFilterAction<A>, ModalFormAction<A>, OrderableModalFormAction<A>, QueryBuilderFilterAction<A>, ResidentMapCreateAction<A>, RowModalFormAction<A>, SlideOverFormAction<A>, TriggerAction<A>

All Known Implementing Classes:

AbstractAction, DefaultAction, DefaultActionGroup, DefaultAddAdjustmentModalFormAction, DefaultBulkOperationAction, DefaultCloneModalFormAction, DefaultConditionalAction, DefaultCreateModalFormAction, DefaultEntityModalFormAction, DefaultExportGridAction, DefaultFilterAction, DefaultFormAction, DefaultGenerateTemplateAction, DefaultGridRowConditionalAction, DefaultImportGridAction, DefaultInlineGridSelectAction, DefaultLinkAction, DefaultLookupFilterAction, DefaultModalFormAction, DefaultOrderableModalFormAction, DefaultQueryBuilderFilterAction, DefaultResidentMapCreateAction, DefaultRowModalFormAction, DefaultSlideOverFormAction, DefaultTriggerAction

public interface Action<A extends Action<A>>
extends Serializable, Comparable<A>, Copyable<A>

Represents the metadata for an action.

Author:

Nick Crum (ncrum)

Method Summary

Modifier and Type	Method	Description
default A	addComponent(String key, Component<?> component)
default A	addComponents(Map<String,? extends Component<?>> components)
default A	addEndpoint(Endpoint<?> endpoint)
default A	addEndpoint(String type, Endpoint<?> endpoint)
default A	apply(Consumer<? super A> fn)	Executes the provided function with this action as an argument.
default A	attribute(String key, Object value)
default A	clearEndpoints()
default Optional<Object>	findAttribute(String key)
default Optional<Component<?>>	findComponent(String key)
default Optional<Component<?>>	findComponent(Predicate<Component<?>> predicate)
default Collection<Component<?>>	findComponents(Predicate<Component<?>> predicate)
default Optional<Endpoint<?>>	findEndpoint(String type)
default Optional<Endpoint<?>>	findEndpoint(Predicate<Endpoint<?>> predicate)
default Collection<Endpoint<?>>	findEndpoints(Predicate<Endpoint<?>> predicate)
default Component<?>	get(String key)
default <T extends Component<T>> T	get(String key, Class<T> clazz)
default Object	getAttribute(String key)
default <T> T	getAttribute(String key, Class<T> clazz)
Map<String,Object>	getAttributes()
default Component<?>	getComponent(String key)
default <T extends Component<T>> T	getComponent(String key, Class<T> clazz)
Map<String,Component<?>>	getComponents()
default Collection<Component<?>>	getComponentsList()
default Endpoint<?>	getEndpoint(String type)
default <E extends Endpoint<E>> E	getEndpoint(String type, Class<E> clazz)
Map<String,Endpoint<?>>	getEndpoints()
default Collection<Endpoint<?>>	getEndpointsList()
String	getId()
InternationalizedMessage	getLabel()
OperationType	getOperationType()
Integer	getOrder()
String	getPlacement()
String	getScope()
SuccessResponse	getSuccessResponse()	Gets the configuration defining how to handle a successful response from this action.
String	getType()
default boolean	hasAttribute(String key)
default boolean	hasComponent(String key)
default boolean	hasEndpoint(String type)
default A	id(String id)
default A	label(InternationalizedMessage label)
default A	label(String label)
default A	operationType(OperationType operationType)
default A	order(Integer order)
default A	placement(String placement)
default A	removeAttribute(String key)
default A	removeComponent(String key)
default A	removeEndpoint(String type)
default A	scope(String scope)
default A	self()
void	setAttributes(Map<String,Object> attributes)
void	setComponents(Map<String,Component<?>> components)
void	setEndpoints(Map<String,Endpoint<?>> endpoints)
void	setId(String id)
void	setLabel(InternationalizedMessage label)
void	setOperationType(OperationType operationType)
void	setOrder(Integer order)
void	setPlacement(String placement)
void	setScope(String scope)
void	setSuccessResponse(SuccessResponse successResponse)	Sets the configuration defining how to handle a successful response from this action.
void	setType(String type)
default A	successResponse(Consumer<SuccessResponse> fn)	Configures the behavior for a successful response.
default A	type(String type)

Methods inherited from interface java.lang.Comparable

compareTo

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

copy

Method Details

getId

@Nullable
String getId()

getPlacement

@Nullable
String getPlacement()

getType

@Nullable
String getType()

getOperationType

@Nullable
OperationType getOperationType()

getScope

@Nullable
String getScope()

getLabel

@Nullable
InternationalizedMessage getLabel()

getOrder

@Nullable
Integer getOrder()

getAttributes

Map<String,Object> getAttributes()

getComponents

Map<String,Component<?>> getComponents()

getEndpoints

Map<String,Endpoint<?>> getEndpoints()

getSuccessResponse

@Nullable
SuccessResponse getSuccessResponse()

Gets the configuration defining how to handle a successful response from this action.

Returns:

the success response configuration

setId

void setId(String id)

setPlacement

void setPlacement(String placement)

setType

void setType(String type)

setOperationType

void setOperationType(OperationType operationType)

setScope

void setScope(String scope)

setLabel

void setLabel(InternationalizedMessage label)

setOrder

void setOrder(Integer order)

setAttributes

void setAttributes(Map<String,Object> attributes)

setComponents

void setComponents(Map<String,Component<?>> components)

setEndpoints

void setEndpoints(Map<String,Endpoint<?>> endpoints)

setSuccessResponse

void setSuccessResponse(SuccessResponse successResponse)

Sets the configuration defining how to handle a successful response from this action.

Parameters:

successResponse - the success response configuration

getComponentsList

default Collection<Component<?>> getComponentsList()

getEndpointsList

default Collection<Endpoint<?>> getEndpointsList()

self

default A self()

apply

default A apply(Consumer<? super A> fn)

Executes the provided function with this action as an argument.

Parameters:

fn - the function

Returns:

this

id

default A id(String id)

placement

default A placement(String placement)

type

default A type(String type)

operationType

default A operationType(OperationType operationType)

scope

default A scope(String scope)

label

default A label(String label)

label

default A label(InternationalizedMessage label)

successResponse

default A successResponse(Consumer<SuccessResponse> fn)

Configures the behavior for a successful response.

order

default A order(Integer order)

attribute

default A attribute(String key,
 @Nullable
 Object value)

removeAttribute

default A removeAttribute(String key)

hasAttribute

default boolean hasAttribute(String key)

getAttribute

default Object getAttribute(String key)

getAttribute

default <T> T getAttribute(String key,
 Class<T> clazz)

findAttribute

default Optional<Object> findAttribute(String key)

addComponent

default A addComponent(String key,
 Component<?> component)

addComponents

default A addComponents(Map<String,? extends Component<?>> components)

removeComponent

default A removeComponent(String key)

hasComponent

default boolean hasComponent(String key)

getComponent

default Component<?> getComponent(String key)

getComponent

default <T extends Component<T>> T getComponent(String key,
 Class<T> clazz)

get

default Component<?> get(String key)

get

default <T extends Component<T>> T get(String key,
 Class<T> clazz)

findComponents

default Collection<Component<?>> findComponents(Predicate<Component<?>> predicate)

findComponent

default Optional<Component<?>> findComponent(Predicate<Component<?>> predicate)

findComponent

default Optional<Component<?>> findComponent(String key)

hasEndpoint

default boolean hasEndpoint(String type)

getEndpoint

default Endpoint<?> getEndpoint(String type)

getEndpoint

default <E extends Endpoint<E>> E getEndpoint(String type,
 Class<E> clazz)

findEndpoints

default Collection<Endpoint<?>> findEndpoints(Predicate<Endpoint<?>> predicate)

findEndpoint

default Optional<Endpoint<?>> findEndpoint(Predicate<Endpoint<?>> predicate)

findEndpoint

default Optional<Endpoint<?>> findEndpoint(String type)

addEndpoint

default A addEndpoint(Endpoint<?> endpoint)

addEndpoint

default A addEndpoint(String type,
 Endpoint<?> endpoint)

removeEndpoint

default A removeEndpoint(String type)

clearEndpoints

default A clearEndpoints()