com.elasticpath.domain.dataimport
Interface ImportJob

All Superinterfaces:

Entity, EpDomain, Persistence, java.io.Serializable

All Known Implementing Classes:

ImportJobImpl

public interface ImportJob
extends Entity

Represents a import job.

Method Summary

CmUser	getCmUser() Returns the cm user whom started the import job.
char	getCsvFileColDelimeter() Returns the import csv data file column delimeter.
java.lang.String	getCsvFileName() Returns the import csv data file name.
char	getCsvFileTextQualifier() Returns the import csv data file text qualifier.
java.lang.String	getImportDataTypeName() Returns the import data type name.
ImportType	getImportType() Returns the import type.
java.util.Map	getMappings() Returns the mappings between import data type fields and csv file columns.
int	getMaxAllowErrors() Returns the maximum allowable errors before teminating import.
java.lang.String	getName() Returns the name of import job.
int	getTotalRows() Return total rows of the csv file.
void	setCmUser(CmUser cmUser) Set the cm user whom started the import job.
void	setCsvFileColDelimeter(char colDelimeter) Set the csv file column delimeter.
void	setCsvFileName(java.lang.String csvFileName) Set the csv file name.
void	setCsvFileTextQualifier(char textQualifier) Set the csv file text qualifier.
void	setImportDataTypeName(java.lang.String importDataTypeName) Set the import data type name.
void	setImportType(ImportType importType) Set the import type.
void	setMappings(java.util.Map mappings) Set the mappings between import data type fields and csv file columns.
void	setMaxAllowErrors(int maxAllowErrors) Set the maximum allowable errors before teminating import.
void	setName(java.lang.String name) Set the name of import job.
void	setTotalRows(int totalRows) Sets the total rows.

Methods inherited from interface com.elasticpath.domain.Entity

getGuid, setGuid

Methods inherited from interface com.elasticpath.domain.Persistence

executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk

Methods inherited from interface com.elasticpath.domain.EpDomain

getElasticPath, setElasticPath

Method Detail

getCmUser

CmUser getCmUser()

Returns the cm user whom started the import job.

Returns:

the cmUser of the import job.

getCsvFileColDelimeter

char getCsvFileColDelimeter()

Returns the import csv data file column delimeter.

Returns:

the import data file column delimeter.

getCsvFileName

java.lang.String getCsvFileName()

Returns the import csv data file name.

Returns:

the import data file name.

getCsvFileTextQualifier

char getCsvFileTextQualifier()

Returns the import csv data file text qualifier.

Returns:

the import data file text qualifier.

getImportDataTypeName

java.lang.String getImportDataTypeName()

Returns the import data type name.

Returns:

the import data type name

getImportType

ImportType getImportType()

Returns the import type.

Returns:

the import type

getMappings

java.util.Map getMappings()

Returns the mappings between import data type fields and csv file columns. Import data type field name will be the key and the csv file column number will be the value.

Returns:

the mappings between import data type fields and csv file columns

getMaxAllowErrors

int getMaxAllowErrors()

Returns the maximum allowable errors before teminating import.

Returns:

the maximum allowable errors before teminate import

getName

java.lang.String getName()

Returns the name of import job.

Returns:

the name of the import job.

getTotalRows

int getTotalRows()

Return total rows of the csv file.

Returns:

total rows of the csv file.

setCmUser

void setCmUser(CmUser cmUser)

Set the cm user whom started the import job.

Parameters:

cmUser - the cm user to set

setCsvFileColDelimeter

void setCsvFileColDelimeter(char colDelimeter)

Set the csv file column delimeter.

Parameters:

colDelimeter - the csv file column delimeter

setCsvFileName

void setCsvFileName(java.lang.String csvFileName)

Set the csv file name.

Parameters:

csvFileName - the csv file name

setCsvFileTextQualifier

void setCsvFileTextQualifier(char textQualifier)

Set the csv file text qualifier.

Parameters:

textQualifier - the text qualifier

setImportDataTypeName

void setImportDataTypeName(java.lang.String importDataTypeName)

Set the import data type name.

Parameters:

importDataTypeName - the import data type name

setImportType

void setImportType(ImportType importType)

Set the import type.

Parameters:

importType - the import type to set.

setMappings

void setMappings(java.util.Map mappings)

Set the mappings between import data type fields and csv file columns. Import data type field name will be the key and the csv file column number will be the value.

Parameters:

mappings - the mappings to set

setMaxAllowErrors

void setMaxAllowErrors(int maxAllowErrors)

Set the maximum allowable errors before teminating import.

Parameters:

maxAllowErrors - the maximum allowable errors

setName

void setName(java.lang.String name)

Set the name of import job.

Parameters:

name - the name to set

setTotalRows

void setTotalRows(int totalRows)

Sets the total rows.

Parameters:

totalRows - the total rows to set.