com.elasticpath.domain.dataimport
Interface ImportRunningJob

All Superinterfaces:
EpDomain, java.io.Serializable, Transient
All Known Implementing Classes:
ImportRunningJobImpl

public interface ImportRunningJob
extends Transient

Represents a running import job.


Method Summary
 void addBadRow(ImportBadRow importBadRow)
          Add an ImportBadRow.
 java.util.List getBadRows()
          Returns a list of ImportBadRow.
 int getCurrentRow()
          Returns the current row number is in importing.
 java.util.Date getEndTime()
          Returns the import job end time.
 int getFailedRows()
          Returns the row number that failed the imported.
 ImportJob getImportJob()
          Returns the import job that is running.
 int getLeftRows()
          Returns the left rows to import.
 java.util.Date getStartTime()
          Returns the import job start time.
 int getSucceededRows()
          Returns the row number that has been imported successfully.
 int getTotalRows()
          Returns the total number of rows to import.
 boolean isFinished()
          Returns true if the job is finished, otherwise, false.
 void setCurrentRow(int currentRow)
          Set the current row number.
 void setFinished()
          Sets the finished flag to true.
 void setImportJob(ImportJob importJob)
          Set the import job to run.
 void updateFailedRows(int num)
          Adds the given number to the failed rows number.
 void updateSucceededRows(int num)
          Adds the given number to the succeeded rows number.
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

addBadRow

void addBadRow(ImportBadRow importBadRow)
Add an ImportBadRow.

Parameters:
importBadRow - the import bad row to add.

getBadRows

java.util.List getBadRows()
Returns a list of ImportBadRow.

Returns:
a list of ImportBadRow

getCurrentRow

int getCurrentRow()
Returns the current row number is in importing.

Returns:
the current row number is in importing

getEndTime

java.util.Date getEndTime()
Returns the import job end time.

Returns:
the import job end time

getFailedRows

int getFailedRows()
Returns the row number that failed the imported.

Returns:
the row number that failed the imported

getImportJob

ImportJob getImportJob()
Returns the import job that is running.

Returns:
the import job that is running

getLeftRows

int getLeftRows()
Returns the left rows to import.

Returns:
the left rows to import

getStartTime

java.util.Date getStartTime()
Returns the import job start time.

Returns:
the import job start time

getSucceededRows

int getSucceededRows()
Returns the row number that has been imported successfully.

Returns:
the row number that has been imported successfully

getTotalRows

int getTotalRows()
Returns the total number of rows to import.

Returns:
the total number of rows to import

isFinished

boolean isFinished()
Returns true if the job is finished, otherwise, false.

Returns:
true if the job is finished, otherwise, false

setCurrentRow

void setCurrentRow(int currentRow)
Set the current row number.

Parameters:
currentRow - the current row number

setFinished

void setFinished()
Sets the finished flag to true.


setImportJob

void setImportJob(ImportJob importJob)
Set the import job to run.

Parameters:
importJob - the import job to set

updateFailedRows

void updateFailedRows(int num)
Adds the given number to the failed rows number.

Parameters:
num - the number

updateSucceededRows

void updateSucceededRows(int num)
Adds the given number to the succeeded rows number.

Parameters:
num - the number