Package net.webpdf.wsclient.openapi

Class MetadataInformation

  • public class MetadataInformation
extends Object
    Summarizes structural information and settings for the PDF document.

    • Constructor Detail

      • MetadataInformation

        public MetadataInformation()

    • Method Detail

      • getAttachments

        @Nullable
public @Nullable Integer getAttachments()
        The number of attachments contained in the document. minimum: 0
        Returns:
        attachments

      • setAttachments

        public void setAttachments​(Integer attachments)

      • getDescription

        @NotNull
public @NotNull MetadataDescription getDescription()
        Get description
        Returns:
        description

      • getDocMDP

        @Nullable
public @Nullable MetadataInformation.DocMDPEnum getDocMDP()
        A document \"Modification Detection and Prevention\" may be set, that defines which modifications of the document are allowed and which modifications would render the signature invalid. * none = The document is unprotected - modify it as you please. * noChangesAllowed = Any modifications of the document would render the signatures invalid. * formFillingSignatures = You may fill in forms and further sign the document. * formFillingSignaturesAndAnnotations = Form filling, signing and adding annotations are allowed.
        Returns:
        docMDP

      • getEncrypted

        @Nullable
public @Nullable Boolean getEncrypted()
        This will be set to \"true\" for a document, that is either password protected or certificate encrypted.
        Returns:
        encrypted

      • setEncrypted

        public void setEncrypted​(Boolean encrypted)

      • getFileSize

        @Nullable
public @Nullable Long getFileSize()
        The byte size of the document. minimum: 0 maximum: 9223372036854775807
        Returns:
        fileSize

      • setFileSize

        public void setFileSize​(Long fileSize)

      • getFormType

        @Nullable
public @Nullable MetadataInformation.FormTypeEnum getFormType()
        When set to another value than \"none\", the document does contain a PDF form in the hereby given format. * none = The document does not contain a form. * acroForm = The document contains a standard PDF Acroform. * staticXFA = The document contains a \"XML Forms Architecture\" form with a fixed layout (static). * dynamicXFA = The document contains a \"XML Forms Architecture\" form with an adaptable/interactive layout (dynamic).
        Returns:
        formType

      • getInitialPage

        @Nullable
public @Nullable Integer getInitialPage()
        The first page, that shall be displayed when opening the document in a PDF Reader.
        Returns:
        initialPage

      • setInitialPage

        public void setInitialPage​(Integer initialPage)

      • getInitialView

        @Nullable
public @Nullable MetadataInformation.InitialViewEnum getInitialView()
        Defines which sub-windows will be opened when the PDF document is opened. * none = No special view * outlines = Opens the \"Bookmarks\" tab * thumbnails = Opens the \"Thumbnails\" tab * fullscreen = Opens the document in full screen mode
        Returns:
        initialView

      • getLanguage

        @Nullable
public @Nullable String getLanguage()
        The natural language of the document. This could either contain the language name or a language tag.
        Returns:
        language

      • setLanguage

        public void setLanguage​(String language)

      • getMagnification

        @Nullable
public @Nullable MetadataInformation.MagnificationEnum getMagnification()
        The initial page zoom settings of a document. When opening the document in a Reader, this zoom settings shall be used. * none = Uses the application's default view. * fitWidth = Page width. * fitPage = Page dimensions. * fitHeight = Page height. * fitVisible = Page content width. * fitActual = Uses the original page dimensions (100% zoom factor). * zoom = Sets an explicit magnification value.
        Returns:
        magnification

      • getMagnificationZoom

        @Nullable
public @Nullable Integer getMagnificationZoom()
        If a magnification \"zoom\" is selected for this document, this is the actual percentage the pages of the document shall be zoomed to, when opening the document in a PDF Reader. minimum: 0
        Returns:
        magnificationZoom

      • setMagnificationZoom

        public void setMagnificationZoom​(Integer magnificationZoom)

      • getObjectKey

        @Nullable
public @Nullable String getObjectKey()
        The object ID of the document's catalog. (root) **Info:** A PDF object ID consists of two numbers, where the first number selects the object's number and the second the \"generation\" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
        Returns:
        objectKey

      • setObjectKey

        public void setObjectKey​(String objectKey)

      • getPageLayout

        @Nullable
public @Nullable MetadataInformation.PageLayoutEnum getPageLayout()
        The set initial page layout of a document. When opening the document in a Reader, this layout shall be selected to display pages. * singlePage = One page at a time. * oneColumn = One continuous column of pages. * twoColumnLeft = The pages in two columns, with odd-numbered pages on the left. * twoColumnRight = The pages in two columns, with odd-numbered pages on the right. * twoPageLeft = Display the pages two at a time, with odd-numbered pages on the left. * twoPageRight = Display the pages two at a time, with odd-numbered pages on the right.
        Returns:
        pageLayout

      • getPages

        @Nullable
public @Nullable Integer getPages()
        The number of pages contained in the document. minimum: 0
        Returns:
        pages

      • setPages

        public void setPages​(Integer pages)

      • getPdfa

        @NotNull
public @NotNull MetadataPdfa getPdfa()
        Get pdfa
        Returns:
        pdfa

      • getPortfolio

        @Nullable
public @Nullable Boolean getPortfolio()
        Will be set to \"true\" for a \"PDF collection\" (Portfolio), that serves as the container for other documents.
        Returns:
        portfolio

      • setPortfolio

        public void setPortfolio​(Boolean portfolio)

      • getSignatures

        @Nullable
public @Nullable Integer getSignatures()
        The number of signatures contained in the document.
        Returns:
        signatures

      • setSignatures

        public void setSignatures​(Integer signatures)

      • getVersion

        @Nullable
public @Nullable String getVersion()
        The version name of the PDF standard the document claims compatibility with.
        Returns:
        version

      • setVersion

        public void setVersion​(String version)

      • getViewerPreferences

        @NotNull
public @NotNull MetadataViewerPreferences getViewerPreferences()
        Get viewerPreferences
        Returns:
        viewerPreferences

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object