Package net.webpdf.wsclient.openapi

Class OperationPortfolioExtract

java.lang.Object

net.webpdf.wsclient.openapi.OperationPortfolioExtract

public class OperationPortfolioExtract
extends Object

Extracts one or more documents from the portfolio. The result will be returned as a ZIP document. The ZIP document will not only contain the extracted files, but will also reproduce the folder structure in which the documents were found.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_SELECTION
static String	JSON_PROPERTY_SINGLE_FILE_AS_ZIP

Constructor Summary

Constructors

Constructor	Description
OperationPortfolioExtract()

Method Summary

Modifier and Type	Method	Description
OperationPortfolioExtract	addSelectionItem(OperationPortfolioSelection selectionItem)
boolean	equals(Object o)
@Nullable List<OperationPortfolioSelection>	getSelection()	Get selection
@Nullable Boolean	getSingleFileAsZip()	The returned attachments will be generated as a ZIP file even if selection is used to select only one single file.
int	hashCode()
OperationPortfolioExtract	selection(List<OperationPortfolioSelection> selection)
void	setSelection(List<OperationPortfolioSelection> selection)
void	setSingleFileAsZip(Boolean singleFileAsZip)
OperationPortfolioExtract	singleFileAsZip(Boolean singleFileAsZip)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_SELECTION

public static final String JSON_PROPERTY_SELECTION

See Also:

Constant Field Values

JSON_PROPERTY_SINGLE_FILE_AS_ZIP

public static final String JSON_PROPERTY_SINGLE_FILE_AS_ZIP

See Also:

Constant Field Values

Constructor Detail

OperationPortfolioExtract

public OperationPortfolioExtract()

Method Detail

selection

public OperationPortfolioExtract selection(List<OperationPortfolioSelection> selection)

addSelectionItem

public OperationPortfolioExtract addSelectionItem(OperationPortfolioSelection selectionItem)

getSelection

@Nullable
public @Nullable List<OperationPortfolioSelection> getSelection()

Get selection

Returns:

selection

setSelection

public void setSelection(List<OperationPortfolioSelection> selection)

singleFileAsZip

public OperationPortfolioExtract singleFileAsZip(Boolean singleFileAsZip)

getSingleFileAsZip

@Nullable
public @Nullable Boolean getSingleFileAsZip()

The returned attachments will be generated as a ZIP file even if selection is used to select only one single file. You can change this behaviour by setting this option to \"false\". In this case, the file will not be zipped, and will instead be returned directly as is. However, this will only work if selection has been used to select one file and one file only.

Returns:

singleFileAsZip

setSingleFileAsZip

public void setSingleFileAsZip(Boolean singleFileAsZip)

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