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

Interface BulkOperationAction<A extends BulkOperationAction<A>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultBulkOperationAction

public interface BulkOperationAction<A extends BulkOperationAction<A>>
extends FormAction<A>

Represents a bulk operation action.

Author:

Jon Fleschler (jfleschler)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BulkOperationAction.Attributes
static final class	BulkOperationAction.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 BulkOperationAction.EndpointTypes.SUBMIT endpoint for the component.
default A	bulkOperationType(String operationType)	Adds the bulk operation type for the action.
default A	entityType(String entityType)	Adds the bulk operation entity type for the action.
default Optional<Endpoint<?>>	findSubmitEndpoint()	Finds the BulkOperationAction.EndpointTypes.SUBMIT endpoint for this component.
default A	generateFriendlyName()
default A	generateFriendlyName(boolean generateFriendlyName)	Whether to generate a friendly name for the action.
default Endpoint<?>	getSubmitEndpoint()	Retrieves the BulkOperationAction.EndpointTypes.SUBMIT endpoint for this component.
default A	notGenerateFriendlyName()
default A	submitEndpoint(UnaryOperator<Endpoint<?>> fn)	Configures the BulkOperationAction.EndpointTypes.SUBMIT endpoint for the component.

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.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

Method Details

generateFriendlyName

default A generateFriendlyName(boolean generateFriendlyName)

Whether to generate a friendly name for the action. If true, the friendly name will be generated based on the operation type and date. If false, the friendly name will be manually set by the user.

Parameters:

generateFriendlyName - whether to generate a friendly name

Returns:

this

generateFriendlyName

default A generateFriendlyName()

notGenerateFriendlyName

default A notGenerateFriendlyName()

bulkOperationType

default A bulkOperationType(String operationType)

Adds the bulk operation type for the action. This is used as the action's id.

Parameters:

operationType - the bulk operation type

Returns:

this

entityType

default A entityType(String entityType)

Adds the bulk operation entity type for the action.

Parameters:

entityType - the bulk operation entity type.

Returns:

this

addSubmitEndpoint

default A addSubmitEndpoint(Endpoint<?> endpoint)

Adds the BulkOperationAction.EndpointTypes.SUBMIT endpoint for the component.

Parameters:

endpoint - the endpoint

Returns:

this

submitEndpoint

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

Configures the BulkOperationAction.EndpointTypes.SUBMIT endpoint for the component.

Parameters:

fn - the function to configure the endpoint

Returns:

this

getSubmitEndpoint

default Endpoint<?> getSubmitEndpoint()

Retrieves the BulkOperationAction.EndpointTypes.SUBMIT endpoint for this component.

Returns:

the endpoint if it exists

See Also:

• for null-safe operation

findSubmitEndpoint

default Optional<Endpoint<?>> findSubmitEndpoint()

Finds the BulkOperationAction.EndpointTypes.SUBMIT endpoint for this component.

Returns:

an optional with the endpoint, or empty