Package net.webpdf.wsclient.openapi

Class DocumentFile

java.lang.Object

net.webpdf.wsclient.openapi.DocumentFile

public class DocumentFile
extends Object

Contains the file information about a document in the document storage

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_DOCUMENT_ID
static String	JSON_PROPERTY_ERROR
static String	JSON_PROPERTY_FILE_EXTENSION
static String	JSON_PROPERTY_FILE_LAST_MODIFIED
static String	JSON_PROPERTY_FILE_NAME
static String	JSON_PROPERTY_FILE_PATH
static String	JSON_PROPERTY_FILE_SIZE
static String	JSON_PROPERTY_FILE_TYPE_GROUPS
static String	JSON_PROPERTY_FILE_TYPE_ID
static String	JSON_PROPERTY_HISTORY_ID
static String	JSON_PROPERTY_IS_FILE_LOCKED
static String	JSON_PROPERTY_METADATA
static String	JSON_PROPERTY_MIME_TYPE
static String	JSON_PROPERTY_PARENT_DOCUMENT_ID
static String	JSON_PROPERTY_PASSWORD

Constructor Summary

Constructors

Constructor	Description
DocumentFile()
DocumentFile(String documentId, String fileExtension, String fileLastModified, String filePath, Long fileSize, String fileTypeGroups, Integer fileTypeId, Integer historyId, Boolean isFileLocked, String mimeType, String parentDocumentId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DocumentFile	error(WebserviceException error)
DocumentFile	fileName(String fileName)
@NotNull String	getDocumentId()	Unique document id, which is required to access this document
@Nullable WebserviceException	getError()	Get error
@Nullable String	getFileExtension()	File extension (without dot)
@Nullable String	getFileLastModified()	Date of the last file modification
@Nullable String	getFileName()	File name for the document (without extension)
@Nullable String	getFilePath()	File path for the document
@Nullable Long	getFileSize()	File size of the document (in bytes)
@Nullable String	getFileTypeGroups()	An internal unique text that describes the group to which the file belongs
@Nullable Integer	getFileTypeId()	An internal unique id for the file type
@Nullable Integer	getHistoryId()	History id of the file entry
@Nullable Boolean	getIsFileLocked()	File is locked on the server, because an other operation uses the file
@Nullable MetadataDocument	getMetadata()	Get metadata
@Nullable String	getMimeType()	Mime type of the document
@Nullable String	getParentDocumentId()	If available, the id of the parent document
@Nullable DocumentPassword	getPassword()	Get password
int	hashCode()
DocumentFile	metadata(MetadataDocument metadata)
DocumentFile	password(DocumentPassword password)
void	setError(WebserviceException error)
void	setFileName(String fileName)
void	setMetadata(MetadataDocument metadata)
void	setPassword(DocumentPassword password)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_DOCUMENT_ID

public static final String JSON_PROPERTY_DOCUMENT_ID

See Also:

Constant Field Values

JSON_PROPERTY_ERROR

public static final String JSON_PROPERTY_ERROR

See Also:

Constant Field Values

JSON_PROPERTY_FILE_EXTENSION

public static final String JSON_PROPERTY_FILE_EXTENSION

See Also:

Constant Field Values

JSON_PROPERTY_FILE_LAST_MODIFIED

public static final String JSON_PROPERTY_FILE_LAST_MODIFIED

See Also:

Constant Field Values

JSON_PROPERTY_FILE_NAME

public static final String JSON_PROPERTY_FILE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_FILE_PATH

public static final String JSON_PROPERTY_FILE_PATH

See Also:

Constant Field Values

JSON_PROPERTY_FILE_SIZE

public static final String JSON_PROPERTY_FILE_SIZE

See Also:

Constant Field Values

JSON_PROPERTY_FILE_TYPE_GROUPS

public static final String JSON_PROPERTY_FILE_TYPE_GROUPS

See Also:

Constant Field Values

JSON_PROPERTY_FILE_TYPE_ID

public static final String JSON_PROPERTY_FILE_TYPE_ID

See Also:

Constant Field Values

JSON_PROPERTY_HISTORY_ID

public static final String JSON_PROPERTY_HISTORY_ID

See Also:

Constant Field Values

JSON_PROPERTY_IS_FILE_LOCKED

public static final String JSON_PROPERTY_IS_FILE_LOCKED

See Also:

Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

Constant Field Values

JSON_PROPERTY_MIME_TYPE

public static final String JSON_PROPERTY_MIME_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_PARENT_DOCUMENT_ID

public static final String JSON_PROPERTY_PARENT_DOCUMENT_ID

See Also:

Constant Field Values

JSON_PROPERTY_PASSWORD

public static final String JSON_PROPERTY_PASSWORD

See Also:

Constant Field Values

Constructor Detail

DocumentFile

public DocumentFile()

DocumentFile

public DocumentFile(String documentId,
                    String fileExtension,
                    String fileLastModified,
                    String filePath,
                    Long fileSize,
                    String fileTypeGroups,
                    Integer fileTypeId,
                    Integer historyId,
                    Boolean isFileLocked,
                    String mimeType,
                    String parentDocumentId)

Method Detail

getDocumentId

@NotNull
public @NotNull String getDocumentId()

Unique document id, which is required to access this document

Returns:

documentId

error

public DocumentFile error(WebserviceException error)

getError

@Nullable
public @Nullable WebserviceException getError()

Get error

Returns:

error

setError

public void setError(WebserviceException error)

getFileExtension

@Nullable
public @Nullable String getFileExtension()

File extension (without dot)

Returns:

fileExtension

getFileLastModified

@Nullable
public @Nullable String getFileLastModified()

Date of the last file modification

Returns:

fileLastModified

fileName

public DocumentFile fileName(String fileName)

getFileName

@Nullable
public @Nullable String getFileName()

File name for the document (without extension)

Returns:

fileName

setFileName

public void setFileName(String fileName)

getFilePath

@Nullable
public @Nullable String getFilePath()

File path for the document

Returns:

filePath

getFileSize

@Nullable
public @Nullable Long getFileSize()

File size of the document (in bytes)

Returns:

fileSize

getFileTypeGroups

@Nullable
public @Nullable String getFileTypeGroups()

An internal unique text that describes the group to which the file belongs

Returns:

fileTypeGroups

getFileTypeId

@Nullable
public @Nullable Integer getFileTypeId()

An internal unique id for the file type

Returns:

fileTypeId

getHistoryId

@Nullable
public @Nullable Integer getHistoryId()

History id of the file entry

Returns:

historyId

getIsFileLocked

@Nullable
public @Nullable Boolean getIsFileLocked()

File is locked on the server, because an other operation uses the file

Returns:

isFileLocked

metadata

public DocumentFile metadata(MetadataDocument metadata)

getMetadata

@Nullable
public @Nullable MetadataDocument getMetadata()

Get metadata

Returns:

metadata

setMetadata

public void setMetadata(MetadataDocument metadata)

getMimeType

@Nullable
public @Nullable String getMimeType()

Mime type of the document

Returns:

mimeType

getParentDocumentId

@Nullable
public @Nullable String getParentDocumentId()

If available, the id of the parent document

Returns:

parentDocumentId

password

public DocumentFile password(DocumentPassword password)

getPassword

@Nullable
public @Nullable DocumentPassword getPassword()

Get password

Returns:

password

setPassword

public void setPassword(DocumentPassword password)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object