com.jurismarches.vradi.services
Interface FileService

All Known Implementing Classes:

FileServiceImpl, FileServiceProxy

public interface FileService

File management service.

Version:

$Revision: 1817 $ Last update : $Date: 2010-12-01 18:20:15 +0100 (mer., 01 déc. 2010) $ By : $Author: sletellier $

Author:

chatellier

Method Summary

File	downloadFormAttachment(boolean convertUrl, String fileName, String formId) Download file.
File	downloadFormAttachment(String uri) Download file.
File	downloadFormAttachment(String fileName, String formId) Download file.
File	downloadFormEmbeddedFile(boolean convertUrl, String fileName, String formId) Download file.
File	downloadFormEmbeddedFile(String uri) Download file.
File	downloadFormEmbeddedFile(String fileName, String formId) Download file.
File	downloadPDF(boolean convertUrl, String uri) Download pdf file.
File	downloadPDF(String uri) Download pdf file.
File	downloadRequestHistory(boolean convertUrl, String uri) Download request history file.
File	downloadRequestHistory(String uri) Download request histiory file.
File	downloadTemplate(boolean convertUrl, String extensionName, String templateName) Download file.
File	downloadTemplate(String extensionName, String templateName) Download file.
File	downloadWebHarvestScript(boolean convertUrl, String uri) Download file.
File	downloadWebHarvestScript(String uri) Download file.
String	getFormEmbeddedUrl(String fileName, String formId)
String	getPDFUrl(String uri) Download pdf file.
String	getRequestHistoryURL(String uri) Get the url of request history.
String	uploadFormAttachment(File file, String formId) Upload a form attachment.
String	uploadFormEmbeddedFile(File file, String formId) Upload a form attachement.
String	uploadTempFile(File file) Upload a temporary file (for example for export).
String	uploadTemplate(File file, String extensionName) Upload a template on server.
String	uploadWebHarvestScript(File file) Upload a web harvest script on server.

Method Detail

uploadTemplate

String uploadTemplate(File file,
                      String extensionName)
                      throws VradiException

Upload a template on server.

Parameters:

file - file to upload

extensionName - extension name to put file into

Returns:

file uri to reference file

Throws:

VradiException - throw VradiException if exception is occured

downloadTemplate

File downloadTemplate(String extensionName,
                      String templateName)
                      throws VradiException

Download file. File may be temporary.

Parameters:

extensionName - extension name

templateName - template name

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadTemplate

File downloadTemplate(boolean convertUrl,
                      String extensionName,
                      String templateName)
                      throws VradiException

Download file. File may be temporary.

Parameters:

convertUrl - if convertion url is necessary

extensionName - extension name

templateName - template name

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

uploadWebHarvestScript

String uploadWebHarvestScript(File file)
                              throws VradiException

Upload a web harvest script on server.

Parameters:

file - file to upload

Returns:

file uri to reference file

Throws:

VradiException - throw VradiException if exception is occured

downloadWebHarvestScript

File downloadWebHarvestScript(String uri)
                              throws VradiException

Download file. File may be temporary.

Parameters:

uri - file uri to download

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadWebHarvestScript

File downloadWebHarvestScript(boolean convertUrl,
                              String uri)
                              throws VradiException

Download file. File may be temporary.

Parameters:

convertUrl - if convertion url is necessary

uri - file uri to download

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadPDF

File downloadPDF(String uri)
                 throws VradiException

Download pdf file. File may be temporary.

Parameters:

uri - file uri to download

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadPDF

File downloadPDF(boolean convertUrl,
                 String uri)
                 throws VradiException

Download pdf file. File may be temporary.

Parameters:

convertUrl - if convertion url is necessary

uri - file uri to download

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

getPDFUrl

String getPDFUrl(String uri)
                 throws VradiException

Download pdf file.

Parameters:

uri - corresponding to history

Returns:

url to go to file

Throws:

VradiException - throw VradiException if exception is occured

uploadFormAttachment

String uploadFormAttachment(File file,
                            String formId)
                            throws VradiException

Upload a form attachment.

Parameters:

file - file to upload

formId - form id

Returns:

file uri to reference file

Throws:

VradiException - if an exception occurred

uploadTempFile

String uploadTempFile(File file)
                      throws VradiException

Upload a temporary file (for example for export).

Parameters:

file - The file to upload

Returns:

an absolute URI on server file system

Throws:

VradiException - if an exception occurred

downloadFormAttachment

File downloadFormAttachment(String uri)
                            throws VradiException

Download file. File may be temporary.

Parameters:

uri - file uri to download

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadFormAttachment

File downloadFormAttachment(boolean convertUrl,
                            String fileName,
                            String formId)
                            throws VradiException

Download file. File may be temporary.

Parameters:

convertUrl - if convertion url is necessary

uri - file uri to download

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadFormAttachment

File downloadFormAttachment(String fileName,
                            String formId)
                            throws VradiException

Download file. File may be temporary.

Parameters:

fileName - to download

formId - concerned

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

uploadFormEmbeddedFile

String uploadFormEmbeddedFile(File file,
                              String formId)
                              throws VradiException

Upload a form attachement.

Parameters:

file - file to upload

formId - form id

Returns:

file uri to reference file

Throws:

VradiException - throw VradiException if exception is occured

downloadFormEmbeddedFile

File downloadFormEmbeddedFile(String uri)
                              throws VradiException

Download file. File may be temporary.

Parameters:

uri - file uri to download

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadFormEmbeddedFile

File downloadFormEmbeddedFile(String fileName,
                              String formId)
                              throws VradiException

Download file. File may be temporary.

Parameters:

fileName - to download

formId - form id

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

downloadFormEmbeddedFile

File downloadFormEmbeddedFile(boolean convertUrl,
                              String fileName,
                              String formId)
                              throws VradiException

Download file. File may be temporary.

Parameters:

convertUrl - if convertion url is necessary

fileName - to download

formId - form id

Returns:

locally downloaded file

Throws:

VradiException - throw VradiException if exception is occured

getFormEmbeddedUrl

String getFormEmbeddedUrl(String fileName,
                          String formId)
                          throws VradiException

Throws:

VradiException

downloadRequestHistory

File downloadRequestHistory(String uri)
                            throws VradiException

Download request histiory file. File may be temporary.

Parameters:

uri - corresponding to history

Returns:

url to go to file

Throws:

VradiException - throw VradiException if exception is occured

downloadRequestHistory

File downloadRequestHistory(boolean convertUrl,
                            String uri)
                            throws VradiException

Download request history file. File may be temporary.

Parameters:

convertUrl - if convertion url is necessary

uri - corresponding to history

Returns:

url to go to file

Throws:

VradiException - throw VradiException if exception is occured

getRequestHistoryURL

String getRequestHistoryURL(String uri)
                            throws VradiException

Get the url of request history.

Parameters:

uri - corresponding to history

Returns:

url to go to file

Throws:

VradiException - throw VradiException if exception is occured