DocumentManager (com.onlyoffice:docs-integration-sdk 1.3.0 API)

All Known Implementing Classes:

DefaultDocumentManager
```
public interface DocumentManager
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getBaseName(String fileName)` Returns the file base name without the full path and extension.
`List<String>`	`getCompareFileExtensions()` Returns a list of extensions that can be used for the document comparison functions.
`List<String>`	`getConvertExtensionList(String fileName)` Returns a list of extensions that the document with the name specified in the request can be converted to.
`String`	`getDefaultConvertExtension(String fileName)` Returns the default OOXML extension to which the document with the name specified in the request should be converted.
`String`	`getDefaultExtension(DocumentType documentType)` Returns the default OOXML extension by the specified document type.
`String`	`getDocumentKey(String fileId, boolean embedded)` Generates a unique document identifier used by the service to recognize the document.
`String`	`getDocumentName(String fileId)` Returns the document name by file ID.
`DocumentType`	`getDocumentType(String fileName)` Returns the document type by the file name.
`String`	`getExtension(String fileName)` Returns the file extension from the file name.
`List<Format>`	`getFormats()` Returns a list of file formats (electronic documents, forms, spreadsheets, presentations) supported by the ONLYOFFICE editors.
`List<String>`	`getInsertImageExtensions()` Returns a list of image extensions that can be inserted into the document.
`Map<String,Boolean>`	`getLossyEditableMap()` Returns a map of extensions that can be edited with the possible loss of information.
`List<String>`	`getMailMergeExtensions()` Returns a list of extensions that can be used for mail merge in the document.
`long`	`getMaxConversionFileSize()` Returns the maximum file size that can be converted in the ONLYOFFICE Conversion Service.
`long`	`getMaxFileSize()` Returns the maximum file size that can be opened in the ONLYOFFICE editor.
`InputStream`	`getNewBlankFile(String extension, Locale locale)` Returns `InputStream` of an empty file with the given extension and locale.
`boolean`	`hasAction(String fileName, String action)` Determines whether an action can be performed on a document with a name specified in the request.
`boolean`	`isEditable(String fileName)` Determines whether a document with a name specified in the request is editable.
`boolean`	`isFillable(String fileName)` Determines whether a document with a name specified in the request is fillable.
`boolean`	`isForm(InputStream inputStream)` Determines whether a file is form.
`boolean`	`isViewable(String fileName)` Determines whether a document with a name specified in the request is viewable.

- Method Detail
  - getFormats
```
List<Format> getFormats()
```
    Returns a list of file formats (electronic documents, forms, spreadsheets, presentations) supported by the ONLYOFFICE editors. The properties of each file format type are described in the list. This information is taken from the Formats repository.
    
    Returns:
    
    A list containing data about the supported formats.
  - getDocumentKey
```
String getDocumentKey(String fileId,
                      boolean embedded)
```
    Generates a unique document identifier used by the service to recognize the document.
    
    Parameters:
    
    fileId - The file ID.
    
    embedded - Specifies if the editor is opened in the embedded mode (true) or not (false).
    
    Returns:
    
    The unique document identifier.
  - getDocumentName
```
String getDocumentName(String fileId)
```
    Returns the document name by file ID.
    
    Parameters:
    
    fileId - The file ID.
    
    Returns:
    
    The document name.
  - getExtension
```
String getExtension(String fileName)
```
    Returns the file extension from the file name.
    
    Parameters:
    
    fileName - The file name to get the extension.
    
    Returns:
    
    The file extension, or null if it doesn't exist, or the file name is empty.
  - getBaseName
```
String getBaseName(String fileName)
```
    Returns the file base name without the full path and extension.
    
    Parameters:
    
    fileName - The file name to get the base name.
    
    Returns:
    
    The file name without the extension or null if the file name is empty.
  - getDocumentType
```
DocumentType getDocumentType(String fileName)
```
    Returns the document type by the file name.
    
    Parameters:
    
    fileName - The file name to get the document type.
    
    Returns:
    
    The document type.
    
    See Also:
    
    DocumentType
  - isEditable
```
boolean isEditable(String fileName)
```
    Determines whether a document with a name specified in the request is editable.
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    True if the document is editable.
  - isViewable
```
boolean isViewable(String fileName)
```
    Determines whether a document with a name specified in the request is viewable.
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    True if the document is viewable.
  - isFillable
```
boolean isFillable(String fileName)
```
    Determines whether a document with a name specified in the request is fillable.
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    True if the document is fillable.
  - hasAction
```
boolean hasAction(String fileName,
                  String action)
```
    Determines whether an action can be performed on a document with a name specified in the request.
    
    Parameters:
    
    fileName - The file name.
    
    action - An action to perform.
    
    Returns:
    
    True if the action can be performed on a document.
    
    See Also:
    
    Formats repository
  - getNewBlankFile
```
InputStream getNewBlankFile(String extension,
                            Locale locale)
```
    Returns InputStream of an empty file with the given extension and locale.
    
    Parameters:
    
    extension - The file extension.
    
    locale - The file locale.
    
    Returns:
    
    InputStream of an empty file.
    
    See Also:
    
    Template repository
  - getDefaultExtension
```
String getDefaultExtension(DocumentType documentType)
```
    Returns the default OOXML extension by the specified document type.
    
    Parameters:
    
    documentType - The document type.
    
    Returns:
    
    The default OOXML extension.
    
    See Also:
    
    DocumentType
  - getDefaultConvertExtension
```
String getDefaultConvertExtension(String fileName)
```
    Returns the default OOXML extension to which the document with the name specified in the request should be converted.
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    The default OOXML extension for conversion.
  - getConvertExtensionList
```
List<String> getConvertExtensionList(String fileName)
```
    Returns a list of extensions that the document with the name specified in the request can be converted to.
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    A list of extensions for conversion.
  - getLossyEditableMap
```
Map<String,Boolean> getLossyEditableMap()
```
    Returns a map of extensions that can be edited with the possible loss of information. If the extension is contained in the "formats.lossy-edit" settings, the value is "true".
    
    Returns:
    
    A map of extensions that can be edited with the possible loss of information.
  - getInsertImageExtensions
```
List<String> getInsertImageExtensions()
```
    Returns a list of image extensions that can be inserted into the document.
    
    Returns:
    
    A list of image extensions.
    
    See Also:
    
    insertImage method in API ONLYOFFICE
  - getCompareFileExtensions
```
List<String> getCompareFileExtensions()
```
    Returns a list of extensions that can be used for the document comparison functions.
    
    Returns:
    
    A list of extensions for the document comparison.
    
    See Also:
    
    setRequestedDocument method in API ONLYOFFICE
  - getMailMergeExtensions
```
List<String> getMailMergeExtensions()
```
    Returns a list of extensions that can be used for mail merge in the document.
    
    Returns:
    
    A list of extensions for mail merge.
    
    See Also:
    
    setRequestedSpreadsheet method in API ONLYOFFICE
  - getMaxFileSize
```
long getMaxFileSize()
```
    Returns the maximum file size that can be opened in the ONLYOFFICE editor.
    
    Returns:
    
    The maximum file size that can be opened.
  - getMaxConversionFileSize
```
long getMaxConversionFileSize()
```
    Returns the maximum file size that can be converted in the ONLYOFFICE Conversion Service.
    
    Returns:
    
    The maximum file size that can be converted.
  - isForm
```
boolean isForm(InputStream inputStream)
```
    Determines whether a file is form.
    
    Parameters:
    
    inputStream - The inputStream of file.
    
    Returns:
    
    True if the file is form.

Interface DocumentManager

Method Summary

Method Detail

getFormats

getDocumentKey

getDocumentName

getExtension

getBaseName

getDocumentType

isEditable

isViewable

isFillable

hasAction

getNewBlankFile

getDefaultExtension

getDefaultConvertExtension

getConvertExtensionList

getLossyEditableMap

getInsertImageExtensions

getCompareFileExtensions

getMailMergeExtensions

getMaxFileSize

getMaxConversionFileSize

isForm