Package com.broadleafcommerce.dataimport.processor.specification.inventory

Class SkuInventoryImportSpecification

java.lang.Object

com.broadleafcommerce.dataimport.processor.specification.DefaultSpecification

com.broadleafcommerce.dataimport.processor.specification.inventory.SkuInventoryImportSpecification

All Implemented Interfaces:

GlobalImportSpecification, ImportSpecification

public class SkuInventoryImportSpecification
extends DefaultSpecification
implements GlobalImportSpecification

Specification for SKU inventory imports, where the input files are defining inventory to create/update in the data store.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_INVENTORY_IMPORT_SPECIFICATION_NAME

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
SkuInventoryImportSpecification(String importType, List<String> requiredAuthorities, List<String> requiredScopes, String name)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String importType)	Whether or not this specification can actually handle the given import.
boolean	parentEntityIdRequiredInRequest()	Certain imports support the concept of Import.getParentEntityId().
protected void	populateHeaderFieldConfigsByRowType(Map<String,Map<String,ImportFieldConfig>> headerFieldConfigsByRowType)	This method is always invoked in the constructor - see DefaultSpecification.createUnmodifiableHeaderFieldConfigsByRowType().
boolean	shouldAllowUnmappedHeaders(String rowType)	This method describes whether imports processed with this specification should allow passthrough of headers with no explicit mapping.

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

getParentEntityIdHeader, hasParentEntity

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

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

Field Details

DEFAULT_INVENTORY_IMPORT_SPECIFICATION_NAME

public static final String DEFAULT_INVENTORY_IMPORT_SPECIFICATION_NAME

See Also:

• Constant Field Values

Constructor Details

SkuInventoryImportSpecification

public SkuInventoryImportSpecification(String importType,
 List<String> requiredAuthorities,
 List<String> requiredScopes,
 String name)

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

shouldAllowUnmappedHeaders

public boolean shouldAllowUnmappedHeaders(String rowType)

Description copied from interface: ImportSpecification

This method describes whether imports processed with this specification should allow passthrough of headers with no explicit mapping.

Essentially, when a record is being processed, if there is no explicit header-to-field mapping possible for a given input via ImportSpecification.getHeaderFieldConfigsByRowType(), or via ImportSpecification.mapDynamicHeaderToField(String, String), this method describes the behavior that should be used.

Some import types may choose to allow such 'unmapped' fields to be passed through with just the raw unmapped header and its corresponding value. For those situations, this method should return true. Other import types may want to intentionally ignore any unmappable headers and exclude them to force strict adherence to the specification. For those, this method should return false.

Note that 'meta' headers/fields such as DefaultImportProcessor.OPERATION_COLUMN have special meaning and thus may not be affected by this setting. See DefaultImportProcessor to understand how such fields are processed.

Specified by:

shouldAllowUnmappedHeaders in interface ImportSpecification

Parameters:

rowType - the row type for which this method should return a preference. Allows for different behavior for different row types within an import

Returns:

true if unmapped headers should be allowed, else false

parentEntityIdRequiredInRequest

public boolean parentEntityIdRequiredInRequest()

Description copied from interface: ImportSpecification

Certain imports support the concept of Import.getParentEntityId(). In some of these cases, it may be desirable to require a value be provided for this in ImportRequest.getParentEntityId().

This method allows the specification to describe whether the initial ImportRequest.getParentEntityId() should be required to have a value. If this is set to true, then any requests that do not provide a value will be rejected.

Specified by:

parentEntityIdRequiredInRequest in interface ImportSpecification

Returns:

whether imports for this specification must supply ImportRequest.getParentEntityId()

See Also:

• ImportValidator.validate(ImportValidationContext)