com.broadleafcommerce.datafeed.domain.fields

Interface DataFeedField

All Superinterfaces:

org.broadleafcommerce.common.copy.MultiTenantCloneable<DataFeedField>, Serializable

All Known Implementing Classes:

DataFeedFieldImpl

public interface DataFeedField
extends Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<DataFeedField>

When the DataFeedType is CUSTOM:
SourcePropertyPath describes the property path to the desired value, assuming SKU as the root object. For example, product.category.name is a valid way to get the category name for a SKU

TargetPropertyPath is the field name in the output file.

Author:

sstevenson

Method Summary

Modifier and Type	Method and Description
String	getAdditionalAttribute(String attributeName)
Map<String,String>	getAdditionalAttributes()
String	getConditionalRule()
DataFeed	getDataFeed()
Boolean	getExcludeIfEmpty()
DataFeedFieldType	getFeedFieldType()
Long	getId()
Boolean	getRequired()
int	getSortOrder() Will return MAXINT-1 if the underlying property is null.
String	getSourcePropertyPath()
String	getTargetPropertyPath()
boolean	hasConfiguredTargetPath()
void	setAdditionalAttributes(Map<String,String> additionalAttributes)
void	setConditionalRule(String conditionalRule)
void	setDataFeed(DataFeed dataFeed)
void	setExcludeIfEmpty(Boolean excludeIfEmpty)
void	setFeedFieldType(DataFeedFieldType feedFieldType)
void	setId(Long id)
void	setRequired(Boolean required)
void	setSortOrder(Integer sortOrder)
void	setSourcePropertyPath(String target)
void	setTargetPropertyPath(String name)

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Method Detail

getId

Long getId()

setId

void setId(Long id)

getSourcePropertyPath

String getSourcePropertyPath()

setSourcePropertyPath

void setSourcePropertyPath(String target)

getTargetPropertyPath

String getTargetPropertyPath()

setTargetPropertyPath

void setTargetPropertyPath(String name)

getDataFeed

DataFeed getDataFeed()

setDataFeed

void setDataFeed(DataFeed dataFeed)

getExcludeIfEmpty

Boolean getExcludeIfEmpty()

setExcludeIfEmpty

void setExcludeIfEmpty(Boolean excludeIfEmpty)

getRequired

Boolean getRequired()

setRequired

void setRequired(Boolean required)

getConditionalRule

String getConditionalRule()

setConditionalRule

void setConditionalRule(String conditionalRule)

getFeedFieldType

DataFeedFieldType getFeedFieldType()

setFeedFieldType

void setFeedFieldType(DataFeedFieldType feedFieldType)

getAdditionalAttribute

String getAdditionalAttribute(String attributeName)

getAdditionalAttributes

Map<String,String> getAdditionalAttributes()

setAdditionalAttributes

void setAdditionalAttributes(Map<String,String> additionalAttributes)

hasConfiguredTargetPath

boolean hasConfiguredTargetPath()

getSortOrder

int getSortOrder()

Will return MAXINT-1 if the underlying property is null. Used to define the order that data fields will be output in a datafeed.

Returns:

setSortOrder

void setSortOrder(Integer sortOrder)