Package net.webpdf.wsclient.openapi

Class OperationFileSpecification

java.lang.Object

net.webpdf.wsclient.openapi.OperationFileSpecification

public class OperationFileSpecification
extends Object

Used to specify the location and additional parameters for running an application or opening a document.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_RESOURCE_U_R_L
static String	JSON_PROPERTY_VOLATILE_FILE

Constructor Summary

Constructors

Constructor	Description
OperationFileSpecification()

Method Summary

Modifier and Type	Method	Description
OperationFileSpecification	description(String description)
boolean	equals(Object o)
@Nullable String	getDescription()	A description of the application that should be opened.
@Nullable String	getResourceURL()	The path or URL for the application / document.
@Nullable Boolean	getVolatileFile()	This value should be set to true if the selected document will be subject to changes continuously and the reader application should be forced to continuously reload the document instead of caching it.
int	hashCode()
OperationFileSpecification	resourceURL(String resourceURL)
void	setDescription(String description)
void	setResourceURL(String resourceURL)
void	setVolatileFile(Boolean volatileFile)
String	toString()
OperationFileSpecification	volatileFile(Boolean volatileFile)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE_U_R_L

public static final String JSON_PROPERTY_RESOURCE_U_R_L

See Also:

Constant Field Values

JSON_PROPERTY_VOLATILE_FILE

public static final String JSON_PROPERTY_VOLATILE_FILE

See Also:

Constant Field Values

Constructor Detail

OperationFileSpecification

public OperationFileSpecification()

Method Detail

description

public OperationFileSpecification description(String description)

getDescription

@Nullable
public @Nullable String getDescription()

A description of the application that should be opened.

Returns:

description

setDescription

public void setDescription(String description)

resourceURL

public OperationFileSpecification resourceURL(String resourceURL)

getResourceURL

@Nullable
public @Nullable String getResourceURL()

The path or URL for the application / document. Use forward slashes as path separators. It is potentially possible to use platform-specific characters, but this is not recommended. If you do end up using platform-specific characters anyway, they must be preceded by a backslash (‘\\\\').

Returns:

resourceURL

setResourceURL

public void setResourceURL(String resourceURL)

volatileFile

public OperationFileSpecification volatileFile(Boolean volatileFile)

getVolatileFile

@Nullable
public @Nullable Boolean getVolatileFile()

This value should be set to true if the selected document will be subject to changes continuously and the reader application should be forced to continuously reload the document instead of caching it.

Returns:

volatileFile

setVolatileFile

public void setVolatileFile(Boolean volatileFile)

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