Package net.webpdf.wsclient.schema.operation

Class MergeFileDataType

java.lang.Object

net.webpdf.wsclient.schema.operation.MergeFileDataType

All Implemented Interfaces:

FileDataType<byte[]>

public class MergeFileDataType
extends Object
implements FileDataType<byte[]>

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p182602_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p593912_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Contains the BASE64 encoded file that should be inserted or appended. The "format" attribute is used to define whether the file is a single PDF document, a ZIP file containing multiple PDF documents or a list of documents references by ID.
 
                     If a ZIP archive is passed as the source document of the web service request, this parameter can be omitted. The parameter "sourceIsZip" must be set to "true" in that case.
                 </p>
 

Java class for MergeFileDataType complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="MergeFileDataType">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>base64Binary">
       <attGroup ref="{http://schema.webpdf.de/1.0/operation}FileDataGroup"/>
       <attribute name="format" default="pdf">
         <simpleType>
           <restriction base="{http://schema.webpdf.de/1.0/operation}FileDataFormatType">
             <enumeration value="id"/>
             <enumeration value="pdf"/>
             <enumeration value="zip"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="outlineName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
     </extension>
   </simpleContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected FileDataFormatType	format	<?
protected String	outlineName	<?
protected FileDataSourceType	source	<?
protected String	uri	<?
protected byte[]	value

Constructor Summary

Constructors

Constructor	Description
MergeFileDataType()

Method Summary

Modifier and Type	Method	Description
FileDataFormatType	getFormat()	<?
String	getOutlineName()	<?
FileDataSourceType	getSource()	<?
String	getUri()	<?
byte[]	getValue()	Gets the value of the value property.
boolean	isSetFormat()
boolean	isSetOutlineName()
boolean	isSetSource()	Returns true, if a file data source has been set.
boolean	isSetUri()	Returns true, if a file source URI has been set.
boolean	isSetValue()	Returns true, if a direct byte value has been set.
void	setFormat(FileDataFormatType value)	Sets the value of the format property.
void	setOutlineName(String value)	Sets the value of the outlineName property.
void	setSource(FileDataSourceType value)	Sets the value of the source property.
void	setUri(String value)	Sets the value of the uri property.
void	setValue(byte[] value)	Sets the value of the value property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

protected byte[] value

format

protected FileDataFormatType format

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p182602_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p593912_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the format used to pass the documents to be used for merging.
                                 <ul><li>pdf = A single PDF file</li><li>zip = It is a ZIP file that contains one or more PDF documents.</li><li>id = It is a semicolon separated list of document ID's referencing documents already on the server (REST API only).</li></ul></p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p182602_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p593912_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 The "id" parameter can be used only with REST API. Each document that has been uploaded to the server via REST API has a unique ID. This ID can be used to reference the document. In the content of the "data" element, the list is passed as BASE64 content.
                                 Example for two documents:<ul><li>List of documents: 3bde686a47284a2da3bfce62bd6bb8bd;f5c2b314d0c74fd0878d1f4ca310b0ad</li><li>BASE64 encoded: M2JkZTY4NmE0NzI4NGEyZGEzYmZjZTYyYmQ2YmI4YmQ7ZjVjMmIzMTRkMGM3NGZkMDg3OGQxZjRjYTMxMGIwYWQ=</li></ul></p>
 

outlineName

protected String outlineName

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p182602_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p593912_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the base path that should be used for outline nodes of the appended document. This parameter can contain a slash separated path and should ideally end with the name of the document ("A/B/filename"). If this parameter is not set, all outlines will be appended to the root outline node.</p>
 

source

protected FileDataSourceType source

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the data source for the hereby expressed resource.
                         Possible values are:
                         <ul><li>value = The element's value shall contain the BASE64 encoded data.</li><li>uri = The data shall be located at the given uri.</li></ul></p>
 

uri

protected String uri

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The uri the data shall be located at. (This shall only have effect, if the "source" is "uri".)</p>
 

Constructor Detail

MergeFileDataType

public MergeFileDataType()

Method Detail

getValue

public byte[] getValue()

Gets the value of the value property.

Specified by:

getValue in interface FileDataType<byte[]>

Returns:

possible object is byte[]

setValue

public void setValue(byte[] value)

Sets the value of the value property.

Specified by:

setValue in interface FileDataType<byte[]>

Parameters:

value - allowed object is byte[]

isSetValue

public boolean isSetValue()

Description copied from interface: FileDataType

Returns true, if a direct byte value has been set.

Specified by:

isSetValue in interface FileDataType<byte[]>

Returns:

true, if a direct byte value has been set.

getFormat

public FileDataFormatType getFormat()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p182602_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p593912_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the format used to pass the documents to be used for merging.
                                 <ul><li>pdf = A single PDF file</li><li>zip = It is a ZIP file that contains one or more PDF documents.</li><li>id = It is a semicolon separated list of document ID's referencing documents already on the server (REST API only).</li></ul></p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p182602_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p593912_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 The "id" parameter can be used only with REST API. Each document that has been uploaded to the server via REST API has a unique ID. This ID can be used to reference the document. In the content of the "data" element, the list is passed as BASE64 content.
                                 Example for two documents:<ul><li>List of documents: 3bde686a47284a2da3bfce62bd6bb8bd;f5c2b314d0c74fd0878d1f4ca310b0ad</li><li>BASE64 encoded: M2JkZTY4NmE0NzI4NGEyZGEzYmZjZTYyYmQ2YmI4YmQ7ZjVjMmIzMTRkMGM3NGZkMDg3OGQxZjRjYTMxMGIwYWQ=</li></ul></p>
 

Returns:

possible object is FileDataFormatType

setFormat

public void setFormat(FileDataFormatType value)

Sets the value of the format property.

Parameters:

value - allowed object is FileDataFormatType

See Also:

getFormat()

isSetFormat

public boolean isSetFormat()

getOutlineName

public String getOutlineName()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p182602_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p593912_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the base path that should be used for outline nodes of the appended document. This parameter can contain a slash separated path and should ideally end with the name of the document ("A/B/filename"). If this parameter is not set, all outlines will be appended to the root outline node.</p>
 

Returns:

possible object is String

setOutlineName

public void setOutlineName(String value)

Sets the value of the outlineName property.

Parameters:

value - allowed object is String

See Also:

getOutlineName()

isSetOutlineName

public boolean isSetOutlineName()

getSource

public FileDataSourceType getSource()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the data source for the hereby expressed resource.
                         Possible values are:
                         <ul><li>value = The element's value shall contain the BASE64 encoded data.</li><li>uri = The data shall be located at the given uri.</li></ul></p>
 

Specified by:

getSource in interface FileDataType<byte[]>

Returns:

possible object is FileDataSourceType

setSource

public void setSource(FileDataSourceType value)

Sets the value of the source property.

Specified by:

setSource in interface FileDataType<byte[]>

Parameters:

value - allowed object is FileDataSourceType

See Also:

getSource()

isSetSource

public boolean isSetSource()

Description copied from interface: FileDataType

Returns true, if a file data source has been set.

Specified by:

isSetSource in interface FileDataType<byte[]>

Returns:

true, if a file data source has been set.

getUri

public String getUri()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The uri the data shall be located at. (This shall only have effect, if the "source" is "uri".)</p>
 

Specified by:

getUri in interface FileDataType<byte[]>

Returns:

possible object is String

setUri

public void setUri(String value)

Sets the value of the uri property.

Specified by:

setUri in interface FileDataType<byte[]>

Parameters:

value - allowed object is String

See Also:

getUri()

isSetUri

public boolean isSetUri()

Description copied from interface: FileDataType

Returns true, if a file source URI has been set.

Specified by:

isSetUri in interface FileDataType<byte[]>

Returns:

true, if a file source URI has been set.