Package net.webpdf.wsclient.openapi

Class OperationPortfolioFile

java.lang.Object

net.webpdf.wsclient.openapi.OperationPortfolioFile

public class OperationPortfolioFile
extends Object

Used to define an individual document that should be added to the portfolio. This element can be used multiple times if you want to add multiple documents.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_CREATOR
static String	JSON_PROPERTY_DATA
static String	JSON_PROPERTY_FILE_NAME
static String	JSON_PROPERTY_MIME_TYPE
static String	JSON_PROPERTY_PATH

Constructor Summary

Constructors

Constructor	Description
OperationPortfolioFile()

Method Summary

Modifier and Type	Method	Description
OperationPortfolioFile	creator(String creator)
OperationPortfolioFile	data(OperationPortfolioFileData data)
boolean	equals(Object o)
OperationPortfolioFile	fileName(String fileName)
@Nullable String	getCreator()	The creator of the portfolio entry.
@NotNull OperationPortfolioFileData	getData()	Get data
@Nullable String	getFileName()	Defines the name under which the document is stored in the portfolio.
@Nullable String	getMimeType()	The MIME type of the portfolio entry.
@Nullable String	getPath()	Defines the path/folder where the document is stored in the portfolio.
int	hashCode()
OperationPortfolioFile	mimeType(String mimeType)
OperationPortfolioFile	path(String path)
void	setCreator(String creator)
void	setData(OperationPortfolioFileData data)
void	setFileName(String fileName)
void	setMimeType(String mimeType)
void	setPath(String path)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_CREATOR

public static final String JSON_PROPERTY_CREATOR

See Also:

Constant Field Values

JSON_PROPERTY_DATA

public static final String JSON_PROPERTY_DATA

See Also:

Constant Field Values

JSON_PROPERTY_FILE_NAME

public static final String JSON_PROPERTY_FILE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_MIME_TYPE

public static final String JSON_PROPERTY_MIME_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_PATH

public static final String JSON_PROPERTY_PATH

See Also:

Constant Field Values

Constructor Detail

OperationPortfolioFile

public OperationPortfolioFile()

Method Detail

creator

public OperationPortfolioFile creator(String creator)

getCreator

@Nullable
public @Nullable String getCreator()

The creator of the portfolio entry.

Returns:

creator

setCreator

public void setCreator(String creator)

data

public OperationPortfolioFile data(OperationPortfolioFileData data)

getData

@NotNull
public @NotNull OperationPortfolioFileData getData()

Get data

Returns:

data

setData

public void setData(OperationPortfolioFileData data)

fileName

public OperationPortfolioFile fileName(String fileName)

getFileName

@Nullable
public @Nullable String getFileName()

Defines the name under which the document is stored in the portfolio.

Returns:

fileName

setFileName

public void setFileName(String fileName)

mimeType

public OperationPortfolioFile mimeType(String mimeType)

getMimeType

@Nullable
public @Nullable String getMimeType()

The MIME type of the portfolio entry.

Returns:

mimeType

setMimeType

public void setMimeType(String mimeType)

path

public OperationPortfolioFile path(String path)

getPath

@Nullable
public @Nullable String getPath()

Defines the path/folder where the document is stored in the portfolio. **Important:** A portfolio path is defined by the \"/\" separated nested folder names.

Returns:

path

setPath

public void setPath(String path)

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