Package net.webpdf.wsclient.openapi

Class MetadataAttachment

  • public class MetadataAttachment
extends Object
    This type is used to describe an attachment, that has been embedded in a PDF file. The attachment itself may have connected document information, in that case the \"document\" element will be set.

    • Constructor Detail

      • MetadataAttachment

        public MetadataAttachment()

    • Method Detail

      • getDescription

        @Nullable
public @Nullable String getDescription()
        The file description of the attachment.
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • getDocumentType

        @Nullable
public @Nullable MetadataDocument getDocumentType()
        Get documentType
        Returns:
        documentType

      • setDocumentType

        public void setDocumentType​(MetadataDocument documentType)

      • getFolderId

        @Nullable
public @Nullable Integer getFolderId()
        The numeric ID of the folder containing the attachment. (This is only relevant for PDF Collections/Portfolios - otherwise attachments may not be arranged in a folder tree.)
        Returns:
        folderId

      • setFolderId

        public void setFolderId​(Integer folderId)

      • getMimeType

        @Nullable
public @Nullable String getMimeType()
        The attachment's MIME type.
        Returns:
        mimeType

      • setMimeType

        public void setMimeType​(String mimeType)

      • getName

        @Nullable
public @Nullable String getName()
        The file name of the attachment.
        Returns:
        name

      • setName

        public void setName​(String name)

      • getNumber

        @Nullable
public @Nullable Integer getNumber()
        The position number of the attachment in the embedded files of the document. minimum: 1
        Returns:
        number

      • setNumber

        public void setNumber​(Integer number)

      • getObjectKey

        @Nullable
public @Nullable String getObjectKey()
        The object ID of the attachment. **Info:** A PDF objects ID consists of two number, 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)

      • getPage

        @Nullable
public @Nullable Integer getPage()
        The page (if any), the attachment is placed on. minimum: 0
        Returns:
        page

      • setPage

        public void setPage​(Integer page)

      • getSize

        @Nullable
public @Nullable Double getSize()
        The byte size of the attachment. minimum: 0
        Returns:
        size

      • setSize

        public void setSize​(Double size)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object