org.cyclos.services.system

Interface ImportService

All Superinterfaces:

CRUDService<ImportedFileDTO,ImportedFileData,ImportedFileDataParams>, Service

All Known Subinterfaces:

ImportServiceLocal

All Known Implementing Classes:

ImportServiceSecurity

public interface ImportService
extends CRUDService<ImportedFileDTO,ImportedFileData,ImportedFileDataParams>

Service interface for Imports

Author:

jcomas

Method Summary

Modifier and Type	Method and Description
boolean	abort(@NotNull java.lang.Long importedFileId) Attempts to trigger the abort process of the given import.
ImportedLineData	getImportedLineData(@NotNull java.lang.Long importedLineId) Returns the imported line data
ImportProgressVO	getImportProgress(@NotNull java.lang.Long importedFileId) Returns a double between 0 and 1 indicating the progress of the given import.
ImportedFileSearchData	getSearchData(@NotNull ImportSearchContext context, UserLocatorVO user) Returns information to perform searches over imports.
void	markAsSkipped(@NotNull java.lang.Long importedFileId, @NotNull java.util.List<java.lang.Long> lineIds, boolean skipped) Sets if the lines should be skipped by the import process or not based on the skipped parameter.
void	process(@NotNull java.lang.Long importedFileId) Starts an import
void	saveDescription(@NotNull java.lang.Long importedFileId, java.lang.String description) Saves the description for the specified imported file id.
void	saveImportedLine(@NotNull ImportedLineDTO importedLineDTO) Saves the values of the imported line
Page<ImportedFileVO>	search(@NotNull ImportedFileQuery params) Returns the imports that satisfy the query restrictions.
Page<ImportedLineVO>	searchImportedLines(@NotNull ImportedLineQuery params) Returns the imported lines that matches the query restrictions.
java.lang.Long	upload(@NotNull ImportedFileDTO importedFileDTO, @NotNull SerializableInputStream input, java.lang.String confirmationPassword) Uploads a file to be imported.

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

abort

boolean abort(@NotNull
              @NotNull java.lang.Long importedFileId)
       throws FrameworkException

Attempts to trigger the abort process of the given import. If can returns true, otherwise returns false.

Throws:

FrameworkException

getImportedLineData

ImportedLineData getImportedLineData(@NotNull
                                     @NotNull java.lang.Long importedLineId)
                              throws FrameworkException

Returns the imported line data

Throws:

FrameworkException

getImportProgress

ImportProgressVO getImportProgress(@NotNull
                                   @NotNull java.lang.Long importedFileId)
                            throws FrameworkException

Returns a double between 0 and 1 indicating the progress of the given import.

Throws:

FrameworkException

getSearchData

ImportedFileSearchData getSearchData(@NotNull
                                     @NotNull ImportSearchContext context,
                                     UserLocatorVO user)
                              throws FrameworkException

Returns information to perform searches over imports.

Throws:

FrameworkException

markAsSkipped

void markAsSkipped(@NotNull
                   @NotNull java.lang.Long importedFileId,
                   @NotNull
                   @NotNull java.util.List<java.lang.Long> lineIds,
                   boolean skipped)
            throws FrameworkException

Sets if the lines should be skipped by the import process or not based on the skipped parameter. It is only possible to mark as skipped/not skipped the lines that were validated successfully.

Throws:

FrameworkException

process

void process(@NotNull
             @NotNull java.lang.Long importedFileId)
      throws FrameworkException

Starts an import

Throws:

FrameworkException

saveDescription

void saveDescription(@NotNull
                     @NotNull java.lang.Long importedFileId,
                     java.lang.String description)
              throws FrameworkException

Saves the description for the specified imported file id.

Throws:

FrameworkException

saveImportedLine

void saveImportedLine(@NotNull
                      @NotNull ImportedLineDTO importedLineDTO)
               throws FrameworkException

Saves the values of the imported line

Throws:

FrameworkException

search

Page<ImportedFileVO> search(@NotNull
                            @NotNull ImportedFileQuery params)
                     throws FrameworkException

Returns the imports that satisfy the query restrictions.

Throws:

FrameworkException

searchImportedLines

Page<ImportedLineVO> searchImportedLines(@NotNull
                                         @NotNull ImportedLineQuery params)
                                  throws FrameworkException

Returns the imported lines that matches the query restrictions.

Throws:

FrameworkException

upload

java.lang.Long upload(@NotNull
                      @NotNull ImportedFileDTO importedFileDTO,
                      @NotNull
                      @NotNull SerializableInputStream input,
                      java.lang.String confirmationPassword)
               throws FrameworkException

Uploads a file to be imported. The confirmation password is only checked depending on the imported file type.

Returns:

the imported file id.

Throws:

FrameworkException

See Also:

ImportType.requiresConfirmationPassword()