Package net.webpdf.wsclient.openapi

Class OperationToolboxMergeMerge

  • public class OperationToolboxMergeMerge
extends Object
    The merge operation element can be used to merge documents. **Important:** 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. **Important:** Merging documents could also fail because of signatures or a used PDF/A format. As * by definition - altering PDF/A documents and signed documents would result in an invalidation of such documents/signatures.

    • Constructor Detail

      • OperationToolboxMergeMerge

        public OperationToolboxMergeMerge()

    • Method Detail

      • getMode

        @Nullable
public @Nullable OperationToolboxMergeMerge.ModeEnum getMode()
        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. 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\"). * atTheEnd = At the end of the PDF document * atTheBeginning = At the beginning of the PDF document * afterPage = After a page (please refer to the \"page\" attribute) in the PDF document * beforePage = Before a page (please refer to the \"page\" attribute) in the PDF document
        Returns:
        mode

      • getOutlineName

        @Nullable
public @Nullable String getOutlineName()
        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.
        Returns:
        outlineName

      • setOutlineName

        public void setOutlineName​(String outlineName)

      • getPage

        @Nullable
public @Nullable Integer getPage()
        Used to define the page number where the PDF document should be inserted. minimum: 1
        Returns:
        page

      • setPage

        public void setPage​(Integer page)

      • getRemoveStaticXFA

        @Nullable
public @Nullable Boolean getRemoveStaticXFA()
        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. **Important:** 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 * and write permissions will be removed (That normally can expected to be found in a static XFA document).
        Returns:
        removeStaticXFA

      • setRemoveStaticXFA

        public void setRemoveStaticXFA​(Boolean removeStaticXFA)

      • getResetMetadata

        @Nullable
public @Nullable Boolean getResetMetadata()
        If you enable this parameter, the source document's metadata will be removed and replaced with default values.
        Returns:
        resetMetadata

      • setResetMetadata

        public void setResetMetadata​(Boolean resetMetadata)

      • getSourceIsZip

        @Nullable
public @Nullable Boolean getSourceIsZip()
        If this parameter is enabled, a ZIP archive * 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. **Important:** 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.
        Returns:
        sourceIsZip

      • setSourceIsZip

        public void setSourceIsZip​(Boolean sourceIsZip)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object