Package net.webpdf.wsclient.schema.operation

Class MergeType

  • All Implemented Interfaces:
    ParameterInterface
    public class MergeType
extends BaseToolboxType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The merge operation element can be used to merge documents.
                 </p>
 
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                     When a "merge" operation is performed, the pages and structural information (such as outlines and tag) will be merged. This can result in name conflicts that can prevent a success. If you would rather like to ignore such conflicts use the matching "ignoreConflicts" parameter.
                 </p>
 
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                     Merging documents could also fail because of signatures or a used PDF/A format. As
                     <ul><li>by definition - altering PDF/A documents and signed documents would result in an invalidation of such documents/signatures.</li></ul></p>

    Java class for MergeType complex type

    .

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

    
 <complexType name="MergeType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
       <all>
         <element name="data" type="{http://schema.webpdf.de/1.0/operation}MergeFileDataType"/>
       </all>
       <attribute name="mode" type="{http://schema.webpdf.de/1.0/operation}MergeModeType" default="atTheEnd" />
       <attribute name="page" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="sourceIsZip" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="outlineName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="resetMetadata" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="removeStaticXFA" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • mode

        protected MergeModeType mode
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the mode used to merge the PDF documents. The PDF document passed with the "data" element will be appended to the current PDF document or inserted at a specific point.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The following modes define the position where the documents will be inserted. Instead of a single base document, the "portfolio" mode always expects a ZIP archive. The elements in this archive will be added, all with identical permissions, to the resulting portfolio (the data element is not required at all for "portfolio").
                                 <ul><li>atTheEnd = At the end of the PDF document</li><li>atTheBeginning = At the beginning of the PDF document</li><li>afterPage = After a page (please refer to the "page" attribute) in the PDF document</li><li>beforePage = Before a page (please refer to the "page" attribute) in the PDF document</li></ul></p>

      • page

        protected Integer page
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page number where the PDF document should be inserted.</p>

      • sourceIsZip

        protected Boolean sourceIsZip
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this parameter is enabled, a ZIP archive
                                 <ul><li>containing the documents to merge - will be expected as the webservice's source document. Also - in that case, the "data" parameter is not required. The first element in the ZIP archive will be used as a base document to which all following entries will be appended.</li></ul><b>Important:</b>
                                 The usage of this parameter is expected to be used for the "portfolio" mode. All the documents in the ZIP archive will be added to the portfolio receiving identical permission settings.
                             </p>

      • outlineName

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

      • resetMetadata

        protected Boolean resetMetadata
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If you enable this parameter, the source document's metadata will be removed and replaced with default values.</p>

      • removeStaticXFA

        protected Boolean removeStaticXFA
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this parameter is enabled, all entries related to static XFA documents and all connected extended permission settings will be removed from the document. Using this parameter it is possible to merge static XFA documents with other documents, which is normally forbidden by default.
                             </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 Although this parameter allows the merging of static XFA documents, this will not create a valid static XFA document as a result. All structures qualifying a document as a static XFA document will be removed. The resulting document will contain a pure Acroform and will not be recognized as a XFA form by applications for XFA creation/editing. Also, all extended access
                                 <ul><li>and write permissions will be removed (That normally can expected to be found in a static XFA document).</li></ul></p>

    • Constructor Detail

      • MergeType

        public MergeType()

    • Method Detail

      • isSetData

        public boolean isSetData()

      • getMode

        public MergeModeType getMode()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the mode used to merge the PDF documents. The PDF document passed with the "data" element will be appended to the current PDF document or inserted at a specific point.</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The following modes define the position where the documents will be inserted. Instead of a single base document, the "portfolio" mode always expects a ZIP archive. The elements in this archive will be added, all with identical permissions, to the resulting portfolio (the data element is not required at all for "portfolio").
                                 <ul><li>atTheEnd = At the end of the PDF document</li><li>atTheBeginning = At the beginning of the PDF document</li><li>afterPage = After a page (please refer to the "page" attribute) in the PDF document</li><li>beforePage = Before a page (please refer to the "page" attribute) in the PDF document</li></ul></p>
        Returns:
        possible object is MergeModeType

      • isSetMode

        public boolean isSetMode()

      • getPage

        public int getPage()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page number where the PDF document should be inserted.</p>
        Returns:
        possible object is Integer

      • setPage

        public void setPage​(int value)
        Sets the value of the page property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getPage()

      • isSetPage

        public boolean isSetPage()

      • unsetPage

        public void unsetPage()

      • isSourceIsZip

        public boolean isSourceIsZip()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this parameter is enabled, a ZIP archive
                                 <ul><li>containing the documents to merge - will be expected as the webservice's source document. Also - in that case, the "data" parameter is not required. The first element in the ZIP archive will be used as a base document to which all following entries will be appended.</li></ul><b>Important:</b>
                                 The usage of this parameter is expected to be used for the "portfolio" mode. All the documents in the ZIP archive will be added to the portfolio receiving identical permission settings.
                             </p>
        Returns:
        possible object is Boolean

      • setSourceIsZip

        public void setSourceIsZip​(boolean value)
        Sets the value of the sourceIsZip property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isSourceIsZip()

      • isSetSourceIsZip

        public boolean isSetSourceIsZip()

      • unsetSourceIsZip

        public void unsetSourceIsZip()

      • getOutlineName

        public String getOutlineName()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" 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 source 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()

      • isResetMetadata

        public boolean isResetMetadata()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If you enable this parameter, the source document's metadata will be removed and replaced with default values.</p>
        Returns:
        possible object is Boolean

      • setResetMetadata

        public void setResetMetadata​(boolean value)
        Sets the value of the resetMetadata property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isResetMetadata()

      • isSetResetMetadata

        public boolean isSetResetMetadata()

      • unsetResetMetadata

        public void unsetResetMetadata()

      • isRemoveStaticXFA

        public boolean isRemoveStaticXFA()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this parameter is enabled, all entries related to static XFA documents and all connected extended permission settings will be removed from the document. Using this parameter it is possible to merge static XFA documents with other documents, which is normally forbidden by default.
                             </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p174123_="https://jakarta.ee/xml/ns/jaxb" xmlns:p235432_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 Although this parameter allows the merging of static XFA documents, this will not create a valid static XFA document as a result. All structures qualifying a document as a static XFA document will be removed. The resulting document will contain a pure Acroform and will not be recognized as a XFA form by applications for XFA creation/editing. Also, all extended access
                                 <ul><li>and write permissions will be removed (That normally can expected to be found in a static XFA document).</li></ul></p>
        Returns:
        possible object is Boolean

      • setRemoveStaticXFA

        public void setRemoveStaticXFA​(boolean value)
        Sets the value of the removeStaticXFA property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isRemoveStaticXFA()

      • isSetRemoveStaticXFA

        public boolean isSetRemoveStaticXFA()

      • unsetRemoveStaticXFA

        public void unsetRemoveStaticXFA()