Package com.broadleafcommerce.dataimport.processor.specification

Class CampaignCodeSpecification

java.lang.Object

com.broadleafcommerce.dataimport.processor.specification.DefaultSpecification

com.broadleafcommerce.dataimport.processor.specification.CampaignCodeSpecification

All Implemented Interfaces:

GlobalImportSpecification, ImportSpecification

public class CampaignCodeSpecification
extends DefaultSpecification
implements GlobalImportSpecification

Author:

Vitalii Voronkov (vvoronkov)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CampaignCodeSpecification.Fields
static final class	CampaignCodeSpecification.Headers
static final class	CampaignCodeSpecification.RecordTypes

Field Summary

Fields inherited from class com.broadleafcommerce.dataimport.processor.specification.DefaultSpecification

dependencyMappings, fieldConfigMap

Fields inherited from interface com.broadleafcommerce.dataimport.processor.specification.ImportSpecification

ROW_DETERMINATION_COLUMN

Constructor Summary

Constructors

Constructor	Description
CampaignCodeSpecification(String ImportType, List<ImportDataNormalizer> importDataNormalizers, List<String> requiredAuthorities, List<String> requiredScopes)
CampaignCodeSpecification(List<ImportDataNormalizer> importDataNormalizers, List<String> requiredAuthorities, List<String> requiredScopes)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String importType)	Whether or not this specification can actually handle the given import.
List<ImportDataNormalizer>	getImportDataNormalizers()	The list of ImportDataNormalizer that will be executed to pre-process the data parsed out from the file.
Optional<String>	getParentEntityIdHeader()	In case when entity has parent, we need to specify header in file with parent entity id value
protected ImportServicesProperties	getProperties()
protected void	populateHeaderFieldConfigsByRowType(Map<String,Map<String,ImportFieldConfig>> headerFieldConfigsByRowType)	This method is always invoked in the constructor - see DefaultSpecification.createUnmodifiableHeaderFieldConfigsByRowType().
void	setProperties(ImportServicesProperties properties)
protected boolean	shouldUseParentEntityIdHeader()

Methods inherited from class com.broadleafcommerce.dataimport.processor.specification.DefaultSpecification

getDependencyMappings, getDynamicHeaderMappingConfigsByRowType, getFieldConfigMap, getHeaderFieldConfigsByRowType, getImportType, getName, getRequiredAuthorities, getRequiredHeaders, getRequiredHeaders, getRequiredScopes, isRequiresRowTypeHeader, mapDynamicFieldToHeader, mapDynamicHeaderToField, populateDynamicHeaderMappingsByRowType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.dataimport.processor.specification.GlobalImportSpecification

hasParentEntity

Methods inherited from interface com.broadleafcommerce.dataimport.processor.specification.ImportSpecification

getDependencyMappings, getFieldConfigMap, getHeaderFieldConfigsByRowType, getImportType, getMainRecordType, getName, getRequiredAuthorities, getRequiredHeaders, getRequiredHeaders, getRequiredScopes, isCatalogDiscriminated, isRequiresRowTypeHeader, isSandboxDiscriminated, mapDynamicFieldToHeader, mapDynamicHeaderToField, parentEntityIdRequiredInRequest, resolveAndRemoveRecordType, resolveRecordTypeBeforePropertyMapping, shouldAllowUnmappedHeaders, shouldAutoGenerateOperationTypeForEachRecord, shouldAutoGenerateResourceTierIdForEachRecord

Constructor Details

CampaignCodeSpecification

public CampaignCodeSpecification(List<ImportDataNormalizer> importDataNormalizers,
 List<String> requiredAuthorities,
 List<String> requiredScopes)

CampaignCodeSpecification

public CampaignCodeSpecification(String ImportType,
 List<ImportDataNormalizer> importDataNormalizers,
 List<String> requiredAuthorities,
 List<String> requiredScopes)

Method Details

canHandle

public boolean canHandle(String importType)

Description copied from interface: ImportSpecification

Whether or not this specification can actually handle the given import. Checks will generally be based on the import type.

Specified by:

canHandle in interface ImportSpecification

Overrides:

canHandle in class DefaultSpecification

Returns:

whether or not this specification can actually handle the given import

populateHeaderFieldConfigsByRowType

protected void populateHeaderFieldConfigsByRowType(Map<String,Map<String,ImportFieldConfig>> headerFieldConfigsByRowType)

Description copied from class: DefaultSpecification

This method is always invoked in the constructor - see DefaultSpecification.createUnmodifiableHeaderFieldConfigsByRowType().

Extensions of this class should override this method and use it to populate the values that they want to ultimately be in DefaultSpecification.getHeaderFieldConfigsByRowType().

Overrides:

populateHeaderFieldConfigsByRowType in class DefaultSpecification

Parameters:

headerFieldConfigsByRowType - a special, mutable map instance which implementations should populate with field configurations. This map will ultimately be copied into an unmodifiable separate instance that will actually be used for DefaultSpecification.getHeaderFieldConfigsByRowType().

getParentEntityIdHeader

public Optional<String> getParentEntityIdHeader()

Description copied from interface: GlobalImportSpecification

In case when entity has parent, we need to specify header in file with parent entity id value

Specified by:

getParentEntityIdHeader in interface GlobalImportSpecification

Returns:

parent entity header otherwise an empty optional

shouldUseParentEntityIdHeader

protected boolean shouldUseParentEntityIdHeader()

getImportDataNormalizers

public List<ImportDataNormalizer> getImportDataNormalizers()

Description copied from interface: ImportSpecification

The list of ImportDataNormalizer that will be executed to pre-process the data parsed out from the file.

Specified by:

getImportDataNormalizers in interface ImportSpecification

Returns:

the list of ImportDataNormalizer

getProperties

protected ImportServicesProperties getProperties()

setProperties

@Autowired
public void setProperties(ImportServicesProperties properties)