java.lang.Object
- net.webpdf.wsclient.schema.beans.DocumentFile

All Implemented Interfaces:

Serializable
```
public class DocumentFile
extends Object
implements Serializable
```
An instance of DocumentFile provides information about a Document uploaded to a Session of the webPDF server.

Those information include the referencable document ID of the Document, the Document´s size, name, extension MIME type etc.

The class DocumentFile serves as a data transfer object HttpEntity for such documents. The class Document wraps such DocumentFiles for easier handling by the webPDF wsclient.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

DocumentFile()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@Nullable String`	`getDocumentId()`	Returns the document ID of this document.
`@Nullable Failure`	`getError()`	Returns the stored `Failure`, that was caused by the creation attempt of this document.
`@Nullable String`	`getFileExtension()`	Returns the file extension of this document.
`@Nullable String`	`getFileLastModified()`	Returns the last known modification date of this document.
`@Nullable String`	`getFileName()`	Returns the file name of this document.
`long`	`getFileSize()`	Returns the file size of this document.
`@Nullable String`	`getFileTypeGroups()`	Returns the file type group of this document.
`int`	`getFileTypeId()`	Returns the file type id of this document.
`@Nullable DocumentType`	`getMetadata()`	Return the `DocumentType` metadata of this document.
`@Nullable String`	`getMimeType()`	Returns the MIME type of this document.
`@Nullable String`	`getParentDocumentId()`	Returns the document ID of the parent document.
`boolean`	`isIsFileLocked()`	Returns the file lock of this document.
`void`	`setDocumentId(@Nullable String documentId)`	Sets the document ID of this document.
`void`	`setError(@Nullable Failure error)`	Sets the `Failure`, that was caused by the creation of this document.
`void`	`setFileExtension(@Nullable String documentExtension)`	Sets the file extension of this document.
`void`	`setFileLastModified(@Nullable String fileLastModified)`	Sets the modification date of this document.
`void`	`setFileName(@Nullable String documentName)`	Sets the file name of this document.
`void`	`setFileSize(long fileSize)`	Sets the file size of this document.
`void`	`setFileTypeGroups(@Nullable String setFileTypeGroups)`	Sets the file type group of this document.
`void`	`setFileTypeId(int fileTypeId)`	Sets the file type id of this document.
`void`	`setIsFileLocked(boolean isFileLocked)`	Sets the file lock of this document.
`void`	`setMetadata(@Nullable DocumentType metadata)`	Sets the metadata of this document.
`void`	`setMimeType(@Nullable String mimeType)`	Sets the MIME type of this document.
`void`	`setParentDocumentId(@Nullable String parentDocumentId)`	Sets the document ID of the parent document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentFile
```
public DocumentFile()
```
- Method Detail
  - getDocumentId
```
@Nullable
public @Nullable String getDocumentId()
```
    Returns the document ID of this document.
    
    Returns:
    
    The document ID of this document.
  - setDocumentId
```
public void setDocumentId(@Nullable
                          @Nullable String documentId)
```
    Sets the document ID of this document.
    
    Parameters:
    
    documentId - The document ID of this document.
  - getParentDocumentId
```
@Nullable
public @Nullable String getParentDocumentId()
```
    Returns the document ID of the parent document.
    
    Returns:
    
    The document ID of the parent document.
  - setParentDocumentId
```
public void setParentDocumentId(@Nullable
                                @Nullable String parentDocumentId)
```
    Sets the document ID of the parent document.
    
    Parameters:
    
    parentDocumentId - The document ID of the parent document.
  - getFileSize
```
public long getFileSize()
```
    Returns the file size of this document.
    
    Returns:
    
    The file size of this document.
  - setFileSize
```
public void setFileSize(long fileSize)
```
    Sets the file size of this document.
    
    Parameters:
    
    fileSize - The file size of this document.
  - getMimeType
```
@Nullable
public @Nullable String getMimeType()
```
    Returns the MIME type of this document.
    
    Returns:
    
    The MIME type of this document.
  - setMimeType
```
public void setMimeType(@Nullable
                        @Nullable String mimeType)
```
    Sets the MIME type of this document.
    
    Parameters:
    
    mimeType - The MIME type of this document.
  - getFileName
```
@Nullable
public @Nullable String getFileName()
```
    Returns the file name of this document.
    
    Returns:
    
    the file name of this document.
  - setFileName
```
public void setFileName(@Nullable
                        @Nullable String documentName)
```
    Sets the file name of this document.
    
    Parameters:
    
    documentName - The file name of this document.
  - getFileExtension
```
@Nullable
public @Nullable String getFileExtension()
```
    Returns the file extension of this document.
    
    Returns:
    
    The file extension of this document.
  - setFileExtension
```
public void setFileExtension(@Nullable
                             @Nullable String documentExtension)
```
    Sets the file extension of this document.
    
    Parameters:
    
    documentExtension - The file extension of this document.
  - isIsFileLocked
```
public boolean isIsFileLocked()
```
    Returns the file lock of this document.
    
    Returns:
    
    The file lock of this document.
  - setIsFileLocked
```
public void setIsFileLocked(boolean isFileLocked)
```
    Sets the file lock of this document.
    
    Parameters:
    
    isFileLocked - The file lock of this document.
  - getFileTypeId
```
public int getFileTypeId()
```
    Returns the file type id of this document.
    
    Returns:
    
    The file type id of this document.
  - setFileTypeId
```
public void setFileTypeId(int fileTypeId)
```
    Sets the file type id of this document.
    
    Parameters:
    
    fileTypeId - The file type id of this document.
  - getFileTypeGroups
```
@Nullable
public @Nullable String getFileTypeGroups()
```
    Returns the file type group of this document.
    
    Returns:
    
    The file type group of this document.
  - setFileTypeGroups
```
public void setFileTypeGroups(@Nullable
                              @Nullable String setFileTypeGroups)
```
    Sets the file type group of this document.
    
    Parameters:
    
    setFileTypeGroups - The file type group of this document.
  - getFileLastModified
```
@Nullable
public @Nullable String getFileLastModified()
```
    Returns the last known modification date of this document.
    
    Returns:
    
    The last known modification date of this document.
  - setFileLastModified
```
public void setFileLastModified(@Nullable
                                @Nullable String fileLastModified)
```
    Sets the modification date of this document.
    
    Parameters:
    
    fileLastModified - The modification date of this document.
  - getMetadata
```
@Nullable
public @Nullable DocumentType getMetadata()
```
    Return the DocumentType metadata of this document.
    
    Returns:
    
    The DocumentType metadata of this document.
  - setMetadata
```
public void setMetadata(@Nullable
                        @Nullable DocumentType metadata)
```
    Sets the metadata of this document.
    
    Parameters:
    
    metadata - The metadata of this document.
  - getError
```
@Nullable
public @Nullable Failure getError()
```
    Returns the stored Failure, that was caused by the creation attempt of this document.
    
    Returns:
    
    The Failure, caused by the attempted creation of this document.
  - setError
```
public void setError(@Nullable
                     @Nullable Failure error)
```
    Sets the Failure, that was caused by the creation of this document.
    
    Parameters:
    
    error - The Failure, that was caused by the creation of this document.

Class DocumentFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentFile

Method Detail

getDocumentId

setDocumentId

getParentDocumentId

setParentDocumentId

getFileSize

setFileSize

getMimeType

setMimeType

getFileName

setFileName

getFileExtension

setFileExtension

isIsFileLocked

setIsFileLocked

getFileTypeId

setFileTypeId

getFileTypeGroups

setFileTypeGroups

getFileLastModified

setFileLastModified

getMetadata

setMetadata

getError

setError