Package org.cyclos.impl.system

Interface ImportServiceLocal

All Superinterfaces:

CRUDService<ImportedFileDTO,ImportedFileData,ImportedFileDataParams>, CRUDServiceLocal<ImportedFile,ImportedFileDTO,ImportedFileData,ImportedFileDataParams>, CRUDWithConfirmationPasswordService<ImportedFileDTO,ImportedFileData,ImportedFileDataParams>, ImportService, Service

public interface ImportServiceLocal
extends ImportService, CRUDServiceLocal<ImportedFile,ImportedFileDTO,ImportedFileData,ImportedFileDataParams>

Local interface for imports

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_ENTITY	Scripting attribute: the imported line entity (after successfully processing)
static String	ATTR_ERROR	Scripting attribute: the imported line error (after processing with error)
static String	ATTR_FILE	Scripting attribute: the imported file
static String	ATTR_LINE	Scripting attribute: the imported line
static String	ATTR_NEW_STATUS	Scripting attribute: the old status
static String	ATTR_OLD_STATUS	Scripting attribute: the old status

Method Summary

Modifier and Type	Method	Description
long	archiveImports()	Gets the old imports that were not finished and deletes them.
ImportedLine	findLine(Long id)	Finds a line by id
ImportProgressVO	getImportProgress(ImportedFile importedFile)	Returns the import progress for the given file
ImportType	getImportType(ImportedFileDTO dto)	Returns the import type which matches with the given dto
String	getName(ImportedField field)	Returns the display name of the given field
List<ImportType>	importsWithPermission(User user)	Returns the import types the logged user can see over the given user
long	resumeImport(Long importedFileId)	Triggers the execution of an import.

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.CRUDWithConfirmationPasswordService

getConfirmationPasswordInputForRemove, removeAllWithConfirmationPassword, removeWithConfirmationPassword, saveWithConfirmationPassword

Methods inherited from interface org.cyclos.services.system.ImportService

abort, getImportedLineData, getLineSearchData, getSearchData, markAsSkipped, process, saveImportedLine, search, searchImportedLines, upload

Field Detail

ATTR_FILE

static final String ATTR_FILE

Scripting attribute: the imported file

See Also:

Constant Field Values

ATTR_OLD_STATUS

static final String ATTR_OLD_STATUS

Scripting attribute: the old status

See Also:

Constant Field Values

ATTR_NEW_STATUS

static final String ATTR_NEW_STATUS

Scripting attribute: the old status

See Also:

Constant Field Values

ATTR_LINE

static final String ATTR_LINE

Scripting attribute: the imported line

See Also:

Constant Field Values

ATTR_ERROR

static final String ATTR_ERROR

Scripting attribute: the imported line error (after processing with error)

See Also:

Constant Field Values

ATTR_ENTITY

static final String ATTR_ENTITY

Scripting attribute: the imported line entity (after successfully processing)

See Also:

Constant Field Values

Method Detail

archiveImports

long archiveImports()

Gets the old imports that were not finished and deletes them. Gets the finished old imports and removes the associated information (lines and values) leaving some stats and dates.

findLine

ImportedLine findLine(Long id)
               throws EntityNotFoundException

Finds a line by id

Throws:

EntityNotFoundException

getImportProgress

ImportProgressVO getImportProgress(ImportedFile importedFile)

Returns the import progress for the given file

getImportType

ImportType getImportType(ImportedFileDTO dto)

Returns the import type which matches with the given dto

getName

String getName(ImportedField field)

Returns the display name of the given field

importsWithPermission

List<ImportType> importsWithPermission(User user)

Returns the import types the logged user can see over the given user

resumeImport

long resumeImport(Long importedFileId)

Triggers the execution of an import.