Package net.webpdf.wsclient.openapi

Class OperationExtractToolboxAttachment

java.lang.Object

net.webpdf.wsclient.openapi.OperationExtractToolboxAttachment

public class OperationExtractToolboxAttachment
extends Object

Used to extract one or more attachments from the document. If more than one file is defined with selection, the result is returned in the form of a ZIP document.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_FOLDER_NAME_TEMPLATE
static String	JSON_PROPERTY_SELECTION
static String	JSON_PROPERTY_SINGLE_FILE_AS_ZIP

Constructor Summary

Constructors

Constructor	Description
OperationExtractToolboxAttachment()

Method Summary

Modifier and Type	Method	Description
OperationExtractToolboxAttachment	addSelectionItem(OperationSelectionAttachment selectionItem)
boolean	equals(Object o)
OperationExtractToolboxAttachment	folderNameTemplate(String folderNameTemplate)
@Nullable String	getFolderNameTemplate()	Used to set the template for the page folders in the returned ZIP file
@Nullable List<OperationSelectionAttachment>	getSelection()	Get selection
@Nullable Boolean	getSingleFileAsZip()	The returned attachments will be combined to a common ZIP file, even if the selection is resulting in a single attachment to be selected.
int	hashCode()
OperationExtractToolboxAttachment	selection(List<OperationSelectionAttachment> selection)
void	setFolderNameTemplate(String folderNameTemplate)
void	setSelection(List<OperationSelectionAttachment> selection)
void	setSingleFileAsZip(Boolean singleFileAsZip)
OperationExtractToolboxAttachment	singleFileAsZip(Boolean singleFileAsZip)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_FOLDER_NAME_TEMPLATE

public static final String JSON_PROPERTY_FOLDER_NAME_TEMPLATE

See Also:

Constant Field Values

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

OperationExtractToolboxAttachment

public OperationExtractToolboxAttachment()

Method Detail

folderNameTemplate

public OperationExtractToolboxAttachment folderNameTemplate(String folderNameTemplate)

getFolderNameTemplate

@Nullable
public @Nullable String getFolderNameTemplate()

Used to set the template for the page folders in the returned ZIP file. \"page\\[%d\\]\", for example, would result in a folder called \"page1\" for page 1, etc.

Returns:

folderNameTemplate

setFolderNameTemplate

public void setFolderNameTemplate(String folderNameTemplate)

selection

public OperationExtractToolboxAttachment selection(List<OperationSelectionAttachment> selection)

addSelectionItem

public OperationExtractToolboxAttachment addSelectionItem(OperationSelectionAttachment selectionItem)

getSelection

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

Get selection

Returns:

selection

setSelection

public void setSelection(List<OperationSelectionAttachment> selection)

singleFileAsZip

public OperationExtractToolboxAttachment singleFileAsZip(Boolean singleFileAsZip)

getSingleFileAsZip

@Nullable
public @Nullable Boolean getSingleFileAsZip()

The returned attachments will be combined to a common ZIP file, even if the selection is resulting in a single attachment to be selected. You can change this behaviour by setting this option to \"false\". In that case, this will expect to select a single attachment, that can be returned \"as is\".

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