Package net.webpdf.wsclient.schema.operation

Class ZugferdFileDataType

java.lang.Object

net.webpdf.wsclient.schema.operation.ZugferdFileDataType

All Implemented Interfaces:

FileDataType<byte[]>

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

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">ZUGFeRD file (XML) in "Base64 encoded" format. The ZUGFeRD XSD schema will be used to validate the file before embedding. If it is not valid, the operation will be aborted.</p>
 

Java class for ZugferdFileDataType complex type

.

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

 <complexType name="ZugferdFileDataType">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>base64Binary">
       <attGroup ref="{http://schema.webpdf.de/1.0/operation}FileDataGroup"/>
       <attribute name="version" type="{http://schema.webpdf.de/1.0/operation}ZugferdVersionType" default="v10Comfort" />
     </extension>
   </simpleContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected FileDataSourceType	source	<?
protected String	uri	<?
protected byte[]	value
protected ZugferdVersionType	version	<?

Constructor Summary

Constructors

Constructor	Description
ZugferdFileDataType()

Method Summary

Modifier and Type	Method	Description
FileDataSourceType	getSource()	<?
String	getUri()	<?
byte[]	getValue()	Gets the value of the value property.
ZugferdVersionType	getVersion()	<?
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.
boolean	isSetVersion()
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.
void	setVersion(ZugferdVersionType value)	Sets the value of the version 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

version

protected ZugferdVersionType version

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="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 version of the ZUGFeRD XML file that should be embedded with "xmlFile".
                                 Versions from 1.0 to 2.3 are supported.
                                 Only the "Comfort" profile is available for version 1.0.
                                 Meanwhile, the "Minimum", "Basic WL", "Basic", "EN16931"
                                 (Comfort), and "Extended" profiles are supported for version 2.0.
                                 Version 2.1.x contains the same profiles as version 2.0 and additionally defines the profile "X-Rechnung".
                                 List of versions with the corresponding profiles:
                                 <ul><li>v10Comfort</li><li>v20Minimum</li><li>v20BasicWL</li><li>v20Basic</li><li>v20EN16931</li><li>v20Extended</li><li>v21Minimum</li><li>v21BasicWL</li><li>v21Basic</li><li>v21EN16931</li><li>v21Extended</li><li>v21XRechnung</li><li>v22Minimum</li><li>v22BasicWL</li><li>v22Basic</li><li>v22EN16931</li><li>v22Extended</li><li>v22XRechnung</li><li>v23Minimum</li><li>v23BasicWL</li><li>v23Basic</li><li>v23EN16931</li><li>v23Extended</li><li>v23XRechnung</li></ul></p>
 

source

protected FileDataSourceType source

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" 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:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" 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

ZugferdFileDataType

public ZugferdFileDataType()

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.

getVersion

public ZugferdVersionType getVersion()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="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 version of the ZUGFeRD XML file that should be embedded with "xmlFile".
                                 Versions from 1.0 to 2.3 are supported.
                                 Only the "Comfort" profile is available for version 1.0.
                                 Meanwhile, the "Minimum", "Basic WL", "Basic", "EN16931"
                                 (Comfort), and "Extended" profiles are supported for version 2.0.
                                 Version 2.1.x contains the same profiles as version 2.0 and additionally defines the profile "X-Rechnung".
                                 List of versions with the corresponding profiles:
                                 <ul><li>v10Comfort</li><li>v20Minimum</li><li>v20BasicWL</li><li>v20Basic</li><li>v20EN16931</li><li>v20Extended</li><li>v21Minimum</li><li>v21BasicWL</li><li>v21Basic</li><li>v21EN16931</li><li>v21Extended</li><li>v21XRechnung</li><li>v22Minimum</li><li>v22BasicWL</li><li>v22Basic</li><li>v22EN16931</li><li>v22Extended</li><li>v22XRechnung</li><li>v23Minimum</li><li>v23BasicWL</li><li>v23Basic</li><li>v23EN16931</li><li>v23Extended</li><li>v23XRechnung</li></ul></p>
 

Returns:

possible object is ZugferdVersionType

setVersion

public void setVersion(ZugferdVersionType value)

Sets the value of the version property.

Parameters:

value - allowed object is ZugferdVersionType

See Also:

getVersion()

isSetVersion

public boolean isSetVersion()

getSource

public FileDataSourceType getSource()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" 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:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" 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.