Package net.webpdf.wsclient.openapi

Class OperationXslTransformationFile

java.lang.Object

net.webpdf.wsclient.openapi.OperationXslTransformationFile

public class OperationXslTransformationFile
extends Object

This element defines a file necessary for the transformation, which is passed \"Base64 encoded\". This element can be used with `<resources>` or `<visualization>`. In the case of `<resources>`, this is a file that defines, for example, an XLST stylesheet or a CSS resource. In the case of an X invoice and the parent `<visualization>` it defines a file (XLST stylesheet) which defines a different layout for the PDF output.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationXslTransformationFile.FormatEnum	The type of the resource passed * xlst = An XSLT stylesheet to be used for the transformation. * other = Any other resource that is needed for the transformation.
static class	OperationXslTransformationFile.SourceEnum	Selects the data source for the hereby expressed resource.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_FILE_NAME
static String	JSON_PROPERTY_FORMAT
static String	JSON_PROPERTY_SOURCE
static String	JSON_PROPERTY_URI
static String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
OperationXslTransformationFile()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OperationXslTransformationFile	fileName(String fileName)
OperationXslTransformationFile	format(OperationXslTransformationFile.FormatEnum format)
@Nullable String	getFileName()	The filename of the file.
@Nullable OperationXslTransformationFile.FormatEnum	getFormat()	The type of the resource passed * xlst = An XSLT stylesheet to be used for the transformation. * other = Any other resource that is needed for the transformation.
@Nullable OperationXslTransformationFile.SourceEnum	getSource()	Selects the data source for the hereby expressed resource.
@Nullable String	getUri()	The uri the data shall be located at.
@org.jetbrains.annotations.Nullable byte[]	getValue()	Get value
int	hashCode()
void	setFileName(String fileName)
void	setFormat(OperationXslTransformationFile.FormatEnum format)
void	setSource(OperationXslTransformationFile.SourceEnum source)
void	setUri(String uri)
void	setValue(byte[] value)
OperationXslTransformationFile	source(OperationXslTransformationFile.SourceEnum source)
String	toString()
OperationXslTransformationFile	uri(String uri)
OperationXslTransformationFile	value(byte[] value)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_FILE_NAME

public static final String JSON_PROPERTY_FILE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_FORMAT

public static final String JSON_PROPERTY_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_SOURCE

public static final String JSON_PROPERTY_SOURCE

See Also:

Constant Field Values

JSON_PROPERTY_URI

public static final String JSON_PROPERTY_URI

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

OperationXslTransformationFile

public OperationXslTransformationFile()

Method Detail

fileName

public OperationXslTransformationFile fileName(String fileName)

getFileName

@Nullable
public @Nullable String getFileName()

The filename of the file. This is the name under which the resource can be found again and is especially important for resources that are referenced from other files passed here via this name. (For example, the name of a CSS stylesheet that is referenced by name from an XSLT stylesheet).

Returns:

fileName

setFileName

public void setFileName(String fileName)

format

public OperationXslTransformationFile format(OperationXslTransformationFile.FormatEnum format)

getFormat

@Nullable
public @Nullable OperationXslTransformationFile.FormatEnum getFormat()

The type of the resource passed * xlst = An XSLT stylesheet to be used for the transformation. * other = Any other resource that is needed for the transformation. For example, this can be a CSS stylesheet, which is used by an output file of a transformation if it results in HTML output. **Important:** The order of the resources can be important if multiple transformations are to be performed, i.e. multiple resources of the format \"xlst\" are passed. The transformations are performed in the order in which they are passed, in which case each transformation uses the output of the previous transformation as the starting point for its own transformation.

Returns:

format

setFormat

public void setFormat(OperationXslTransformationFile.FormatEnum format)

source

public OperationXslTransformationFile source(OperationXslTransformationFile.SourceEnum source)

getSource

@Nullable
public @Nullable OperationXslTransformationFile.SourceEnum getSource()

Selects the data source for the hereby expressed resource. Possible values are: * value = The element's value shall contain the BASE64 encoded data. * uri = The data shall be located at the given uri.

Returns:

source

setSource

public void setSource(OperationXslTransformationFile.SourceEnum source)

uri

public OperationXslTransformationFile uri(String uri)

getUri

@Nullable
public @Nullable String getUri()

The uri the data shall be located at. (This shall only have effect, if the \"source\" is \"uri\".)

Returns:

uri

setUri

public void setUri(String uri)

value

public OperationXslTransformationFile value(byte[] value)

getValue

@Nullable
public @org.jetbrains.annotations.Nullable byte[] getValue()

Get value

Returns:

value

setValue

public void setValue(byte[] value)

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