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

Interface ImportGridAction<A extends ImportGridAction<A>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultImportGridAction

public interface ImportGridAction<A extends ImportGridAction<A>>
extends FormAction<A>

This action is used to open the modal dialog with additional configuration to import the entities from the grid.

Author:

Dima Myroniuk (dmyroniuk)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ImportGridAction.ActionTypes
static final class	ImportGridAction.Attributes
static final class	ImportGridAction.DefaultScopes
static final class	ImportGridAction.DefaultURIs
static final class	ImportGridAction.EndpointTypes
static final class	ImportGridAction.ExternalIds
static final class	ImportGridAction.FieldNames
static final class	ImportGridAction.GroupIds

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	addDownloadImportExampleFile(LinkExternal<?> link)	Adds the LinkExternal to download the import file example into the import info group.
default A	addFileInputField(FileInputField<?> field)	Adds the field to select the file to import into a modal dialog form.
default A	addImportGridInfoGroup(Group<?> group)	Adds the group for additional information.
default A	addNameField(Field<?> field)	Adds the field for the import name into a modal dialog form.
default A	addReadImportEndpoint(Endpoint<?> endpoint)	Adds the endpoint to read the import by id.
default A	addStartImportEndpoint(Endpoint<?> endpoint)	Adds the endpoint to start the import.
default A	downloadImportErrors()	Adds the ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_URI and ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_SCOPE attributes with the ImportGridAction.DefaultURIs.DOWNLOAD_IMPORT_ERRORS uri and ImportGridAction.DefaultScopes.DOWNLOAD_IMPORT_ERRORS scope.
default A	downloadImportErrorsScope(String scope)	Adds the ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_SCOPE attribute.
default A	downloadImportErrorsUri(String uri)	Adds the ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_URI attribute.
default A	downloadImportExampleFile(String importType)	Adds the LinkExternal to download the import file example into the import info group.
default A	downloadImportExampleFile(String importType, UnaryOperator<LinkExternal<?>> fn)	Adds the LinkExternal to download the import file example into the import info group.
default A	fileInputField()	Adds the field to select the file to import into a modal dialog form.
default A	fileInputField(UnaryOperator<FileInputField<?>> fn)	Adds the field to select the file to import into a modal dialog form.
default Optional<External<?>>	findDownloadImportFileExampleLink()	Searches the link to download the import example file.
default A	importGridInfoGroup()	Adds the collapsible group for additional information.
default A	importGridInfoGroup(UnaryOperator<Group<?>> fn)	Adds the collapsible group for additional information.
default A	importType(String importType)	Adds the ImportGridAction.Attributes.IMPORT_TYPE attribute.
default A	nameField(String importType)	Adds the field for the import name into a modal dialog form.
default A	nameField(String importType, UnaryOperator<Field<?>> fn)	Adds the field for the import name into a modal dialog form.
default A	readImportEndpoint(String scope)	Adds the endpoint to read the import by id.
default A	readImportEndpoint(String scope, UnaryOperator<Endpoint<?>> fn)	Adds the endpoint to read the import by id.
default A	removeDownloadImportExampleFile()	Removes the link to download the example file from the import info group.
default A	removeFileInputField()	Removes the field to select the file to import.
default A	removeImportGridInfoGroup()	Removes the group for additional information.
default A	removeNameField()	Removes the field for the import name.
default A	removeReadImportEndpoint()	Removes the endpoint to read the import by id.
default A	removeStartImportEndpoint()	Removes the endpoint to start the import.
default A	scope(String scope)	Adds the scope to this action.
default A	startImportEndpoint(String scope)	Adds the endpoint to start the import.
default A	startImportEndpoint(String scope, UnaryOperator<Endpoint<?>> fn)	Adds the endpoint to start the import.

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

scope

default A scope(String scope)

Adds the scope to this action. It also adds the ImportGridAction.DefaultScopes.IMPORT scope to the end separated by whitespace.

Specified by:

scope in interface Action<A extends ImportGridAction<A>>

Parameters:

scope - the OAuth2 scope

Returns:

this action for further customization

startImportEndpoint

default A startImportEndpoint(String scope)

Adds the endpoint to start the import. By default, this adds the ImportGridAction.DefaultURIs.START_IMPORT_URI uri to this endpoint.

Parameters:

scope - the OAuth2 scope

Returns:

this action for further customization

startImportEndpoint

default A startImportEndpoint(String scope,
 UnaryOperator<Endpoint<?>> fn)

Adds the endpoint to start the import. By default, this adds the ImportGridAction.DefaultURIs.START_IMPORT_URI uri to this endpoint.

Parameters:

scope - the OAuth2 scope

fn - the added endpoint for further customization

Returns:

this action for further customization

addStartImportEndpoint

default A addStartImportEndpoint(Endpoint<?> endpoint)

Adds the endpoint to start the import.

Parameters:

endpoint - the endpoint to start the import

Returns:

this action for further customization

removeStartImportEndpoint

default A removeStartImportEndpoint()

Removes the endpoint to start the import.

Returns:

this action for further customization

readImportEndpoint

default A readImportEndpoint(String scope)

Adds the endpoint to read the import by id. By default, this adds the ImportGridAction.DefaultURIs.READ_IMPORT_BY_ID_URI uri to this endpoint.

Parameters:

scope - the OAuth2 scope

Returns:

this action for further customization

readImportEndpoint

default A readImportEndpoint(String scope,
 UnaryOperator<Endpoint<?>> fn)

Adds the endpoint to read the import by id. By default, this adds the ImportGridAction.DefaultURIs.READ_IMPORT_BY_ID_URI uri to this endpoint.

Parameters:

scope - the OAuth2 scope

fn - the added endpoint for further customization

Returns:

this action for further customization

addReadImportEndpoint

default A addReadImportEndpoint(Endpoint<?> endpoint)

Adds the endpoint to read the import by id.

Parameters:

endpoint - the endpoint to read the import by id

Returns:

this action for further customization

removeReadImportEndpoint

default A removeReadImportEndpoint()

Removes the endpoint to read the import by id.

Returns:

this action for further customization

nameField

default A nameField(String importType)

Adds the field for the import name into a modal dialog form.

Parameters:

importType - the import type. This is used to create the default value like: "importType + " - $TIMESTAMP""

Returns:

this action for further customization

nameField

default A nameField(String importType,
 UnaryOperator<Field<?>> fn)

Adds the field for the import name into a modal dialog form.

Parameters:

importType - the import type. This is used to create the default value like: "importType + " - $TIMESTAMP"".

fn - the added field for further customization

Returns:

this action for further customization

addNameField

default A addNameField(Field<?> field)

Adds the field for the import name into a modal dialog form.

Parameters:

field - the added field for further customization

Returns:

this action for further customization

removeNameField

default A removeNameField()

Removes the field for the import name.

Returns:

this action for further customization

fileInputField

default A fileInputField()

Adds the field to select the file to import into a modal dialog form. By default, it accepts the ".csv" files.

Returns:

this action for further customization

fileInputField

default A fileInputField(UnaryOperator<FileInputField<?>> fn)

Adds the field to select the file to import into a modal dialog form. By default, it accepts the ".csv" files.

Parameters:

fn - the added field for further customization

Returns:

this action for further customization

addFileInputField

default A addFileInputField(FileInputField<?> field)

Adds the field to select the file to import into a modal dialog form.

Parameters:

field - the FileInputField to add

Returns:

this action for further customization

removeFileInputField

default A removeFileInputField()

Removes the field to select the file to import.

Returns:

this action for further customization

downloadImportExampleFile

default A downloadImportExampleFile(String importType)

Adds the LinkExternal to download the import file example into the import info group. If the group doesn't exists the the will be created.

Parameters:

importType - the import type

Returns:

this action for further customization

downloadImportExampleFile

default A downloadImportExampleFile(String importType,
 UnaryOperator<LinkExternal<?>> fn)

Adds the LinkExternal to download the import file example into the import info group. If the group doesn't exists the the will be created.

Parameters:

importType - the import type

fn - the added link for further customization

Returns:

this action for further customization

addDownloadImportExampleFile

default A addDownloadImportExampleFile(LinkExternal<?> link)

Adds the LinkExternal to download the import file example into the import info group. If the group doesn't exists the the will be created.

Parameters:

link - the link to add

Returns:

this action for further customization

removeDownloadImportExampleFile

default A removeDownloadImportExampleFile()

Removes the link to download the example file from the import info group.

Returns:

this action for further customization

importGridInfoGroup

default A importGridInfoGroup()

Adds the collapsible group for additional information.

Returns:

this action for further customization

importGridInfoGroup

default A importGridInfoGroup(UnaryOperator<Group<?>> fn)

Adds the collapsible group for additional information.

Parameters:

fn - the added group for further customization

Returns:

this action for further customization

addImportGridInfoGroup

default A addImportGridInfoGroup(Group<?> group)

Adds the group for additional information.

Parameters:

group - the added link for further customization

Returns:

this action for further customization

removeImportGridInfoGroup

default A removeImportGridInfoGroup()

Removes the group for additional information.

Returns:

this action for further customization

importType

default A importType(String importType)

Adds the ImportGridAction.Attributes.IMPORT_TYPE attribute.

Parameters:

importType - the import type

Returns:

this action for further customization

downloadImportErrors

default A downloadImportErrors()

Adds the ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_URI and ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_SCOPE attributes with the ImportGridAction.DefaultURIs.DOWNLOAD_IMPORT_ERRORS uri and ImportGridAction.DefaultScopes.DOWNLOAD_IMPORT_ERRORS scope. This attributes are used to download the file with the import errors.

Returns:

this action for further customization

See Also:

• downloadImportErrorsUri(String)
• downloadImportErrorsScope(String)

downloadImportErrorsUri

default A downloadImportErrorsUri(String uri)

Adds the ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_URI attribute. This uri is used to download the file with the import errors.

Returns:

this action for further customization

downloadImportErrorsScope

default A downloadImportErrorsScope(String scope)

Adds the ImportGridAction.Attributes.DOWNLOAD_IMPORT_ERRORS_SCOPE attribute. This scope is used to download the file with the import errors.

Parameters:

scope - the OAuth2 scope to download the file with the import errors

Returns:

this action for further customization

findDownloadImportFileExampleLink

default Optional<External<?>> findDownloadImportFileExampleLink()

Searches the link to download the import example file.

Returns:

the found external link