Package net.webpdf.wsclient.openapi

Class DocumentFileCompress

java.lang.Object

net.webpdf.wsclient.openapi.DocumentFileCompress

public class DocumentFileCompress
extends Object

Contains the instructions for creating the new archive document and the documents to be added to the archive.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ARCHIVE_FILE_NAME
static String	JSON_PROPERTY_DOCUMENT_ID_LIST
static String	JSON_PROPERTY_FILE_FILTER

Constructor Summary

Constructors

Constructor	Description
DocumentFileCompress()

Method Summary

Modifier and Type	Method	Description
DocumentFileCompress	addDocumentIdListItem(String documentIdListItem)
DocumentFileCompress	archiveFileName(String archiveFileName)
DocumentFileCompress	documentIdList(List<String> documentIdList)
boolean	equals(Object o)
DocumentFileCompress	fileFilter(DocumentFileFilter fileFilter)
@Nullable String	getArchiveFileName()	Sets the file name for the archive document.
@Nullable List<String>	getDocumentIdList()	Sets the list of `documentId`s to be added to the archive document.
@Nullable DocumentFileFilter	getFileFilter()	Get fileFilter
int	hashCode()
void	setArchiveFileName(String archiveFileName)
void	setDocumentIdList(List<String> documentIdList)
void	setFileFilter(DocumentFileFilter fileFilter)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_ARCHIVE_FILE_NAME

public static final String JSON_PROPERTY_ARCHIVE_FILE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_DOCUMENT_ID_LIST

public static final String JSON_PROPERTY_DOCUMENT_ID_LIST

See Also:

Constant Field Values

JSON_PROPERTY_FILE_FILTER

public static final String JSON_PROPERTY_FILE_FILTER

See Also:

Constant Field Values

Constructor Detail

DocumentFileCompress

public DocumentFileCompress()

Method Detail

archiveFileName

public DocumentFileCompress archiveFileName(String archiveFileName)

getArchiveFileName

@Nullable
public @Nullable String getArchiveFileName()

Sets the file name for the archive document.

Returns:

archiveFileName

setArchiveFileName

public void setArchiveFileName(String archiveFileName)

documentIdList

public DocumentFileCompress documentIdList(List<String> documentIdList)

addDocumentIdListItem

public DocumentFileCompress addDocumentIdListItem(String documentIdListItem)

getDocumentIdList

@Nullable
public @Nullable List<String> getDocumentIdList()

Sets the list of `documentId`s to be added to the archive document.

Returns:

documentIdList

setDocumentIdList

public void setDocumentIdList(List<String> documentIdList)

fileFilter

public DocumentFileCompress fileFilter(DocumentFileFilter fileFilter)

getFileFilter

@Nullable
public @Nullable DocumentFileFilter getFileFilter()

Get fileFilter

Returns:

fileFilter

setFileFilter

public void setFileFilter(DocumentFileFilter fileFilter)

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