FileService (Qcadoo Framework :: Javadoc 1.5-SNAPSHOT API)

```
public interface FileService
```
Service for managing files.

Since:

0.4.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`File`	`compressToZipFile(List<File> documents, boolean removeCompressed)` Compress documents to newly created zip file.
`File`	`createExportFile(String filename)` Create empty export file with given name.
`File`	`createReportFile(String filename)` Create empty report file with given name.
`String`	`getContentType(String path)` Returns content type of the file from given path.
`File`	`getFileFromFilenameWithRandomDirectory(String filename)`
`File`	`getFileFromFilenameWithRandomDirectory(String filename, boolean withDate)`
`InputStream`	`getInputStream(String path)` Returns stream of the file from given path.
`String`	`getLastModificationDate(String path)` Returns last modification date of the file from given path.
`String`	`getName(String path)` Returns name of the file from given path.
`String`	`getPathFromUrl(String url)` Returns path for the file from given URL.
`String`	`getUrl(String path)` Returns URL for the file from given path.
`void`	`remove(String path)` Remove the file from given path.
`Entity`	`updateReportFileName(Entity entity, String dateFieldName, String name)` Update report file name for given report entity
`Entity`	`updateReportFileName(Entity entity, String dateFieldName, String name, String... args)` Update report file name for given report entity
`String`	`upload(org.springframework.web.multipart.MultipartFile multipartFile)` Create file from given uploaded file.

- Method Detail
  - compressToZipFile
```
File compressToZipFile(List<File> documents,
                       boolean removeCompressed)
                throws IOException
```
    Compress documents to newly created zip file.
    
    Parameters:
    
    documents - documents to be compress
    
    removeCompressed - if true removes documents after compression
    
    Returns:
    
    created zip file
    
    Throws:
    
    IOException
  - createExportFile
```
File createExportFile(String filename)
```
    Create empty export file with given name.
    
    Parameters:
    
    filename - filename
    
    Returns:
    
    File
  - createReportFile
```
File createReportFile(String filename)
               throws IOException
```
    Create empty report file with given name.
    
    Parameters:
    
    filename - filename
    
    Returns:
    
    File
    
    Throws:
    
    IOException
  - getContentType
```
String getContentType(String path)
```
    Returns content type of the file from given path.
    
    Parameters:
    
    path - path
    
    Returns:
    
    content type
  - getFileFromFilenameWithRandomDirectory
```
File getFileFromFilenameWithRandomDirectory(String filename)
```
  - getFileFromFilenameWithRandomDirectory
```
File getFileFromFilenameWithRandomDirectory(String filename,
                                            boolean withDate)
```
  - getInputStream
```
InputStream getInputStream(String path)
```
    Returns stream of the file from given path.
    
    Parameters:
    
    path - path
    
    Returns:
    
    stream
  - getLastModificationDate
```
String getLastModificationDate(String path)
```
    Returns last modification date of the file from given path.
    
    Parameters:
    
    path - path
    
    Returns:
    
    last modification date
  - getName
```
String getName(String path)
```
    Returns name of the file from given path.
    
    Parameters:
    
    path - path
    
    Returns:
    
    name
  - getPathFromUrl
```
String getPathFromUrl(String url)
```
    Returns path for the file from given URL.
    
    Parameters:
    
    url -
    
    Returns:
    
    path
  - getUrl
```
String getUrl(String path)
```
    Returns URL for the file from given path.
    
    Parameters:
    
    path - path
    
    Returns:
    
    URL
  - remove
```
void remove(String path)
```
    Remove the file from given path.
    
    Parameters:
    
    path - path
  - updateReportFileName
```
Entity updateReportFileName(Entity entity,
                            String dateFieldName,
                            String name)
```
    Update report file name for given report entity
    
    Parameters:
    
    entity -
    
    dateFieldName - report date field name
    
    name - translation code for language specific file name
    
    Returns:
    
    updated entity
  - updateReportFileName
```
Entity updateReportFileName(Entity entity,
                            String dateFieldName,
                            String name,
                            String... args)
```
    Update report file name for given report entity
    
    Parameters:
    
    entity -
    
    dateFieldName - report date field name
    
    name - translation code for language specific file name
    
    args - translation args
    
    Returns:
    
    updated entity
  - upload
```
String upload(org.springframework.web.multipart.MultipartFile multipartFile)
       throws IOException
```
    Create file from given uploaded file.
    
    Parameters:
    
    multipartFile - uploaded file
    
    Returns:
    
    path
    
    Throws:
    
    IOException

Interface FileService

Method Summary

Method Detail

compressToZipFile

createExportFile

createReportFile

getContentType

getFileFromFilenameWithRandomDirectory

getFileFromFilenameWithRandomDirectory

getInputStream

getLastModificationDate

getName

getPathFromUrl

getUrl

remove

updateReportFileName

updateReportFileName

upload