Preview (Silverpeas Core 6.4 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

DocumentView

All Known Implementing Classes:

AbstractPreview, AbstractView, TemporaryFlexPaperView, TemporaryPdfView, TemporaryPreview
```
public interface Preview
extends Serializable
```
Author:

Yohann Chastagnier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDisplayLicenseKey()`	Getting the license of display software product if any
`String`	`getDocumentId()`	Getting the document identifier.
`String`	`getDocumentType()`	Getting the document type (not mime-type, but document service type, 'attachment' for example).
`String`	`getHeight()`	Getting the height of the document
`String`	`getLanguage()`	Getting the language of the document content.
`String`	`getOriginalFileName()`	Getting the original file of the document
`File`	`getPhysicalFile()`	Getting the physical file of the document
`Path`	`getServerFilePath()`	Getting `Path` of the document on the server.
`String`	`getURLAsString()`	Getting URL of the document
`String`	`getWidth()`	Getting the width of the document

- Method Detail
  - getDocumentId
```
String getDocumentId()
```
    Getting the document identifier.
    
    Returns:
    
    a string.
  - getDocumentType
```
String getDocumentType()
```
    Getting the document type (not mime-type, but document service type, 'attachment' for example).
    
    Returns:
    
    a string.
  - getLanguage
```
String getLanguage()
```
    Getting the language of the document content.
    
    Returns:
    
    a string.
  - getDisplayLicenseKey
```
String getDisplayLicenseKey()
```
    Getting the license of display software product if any
    
    Returns:
    
    a string.
  - getURLAsString
```
String getURLAsString()
```
    Getting URL of the document
    
    Returns:
    
    a string.
  - getServerFilePath
```
Path getServerFilePath()
```
    Getting Path of the document on the server.
    
    Returns:
    
    a Path instance.
  - getOriginalFileName
```
String getOriginalFileName()
```
    Getting the original file of the document
    
    Returns:
    
    a string.
  - getPhysicalFile
```
File getPhysicalFile()
```
    Getting the physical file of the document
    
    Returns:
    
    a File instance.
  - getWidth
```
String getWidth()
```
    Getting the width of the document
    
    Returns:
    
    a string.
  - getHeight
```
String getHeight()
```
    Getting the height of the document
    
    Returns:
    
    a string.