Package de.elo.ix.client

Class PreviewImageInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.PreviewImageInfo
All Implemented Interfaces:
Serializable
public class PreviewImageInfo extends ValueClass implements Serializable
Since:
9.00.000.011
See Also:

  • Field Details

    • objectId

      protected String objectId

      ID of the objects to query preview images for. The ID must point to a document. Otherwise, an exception is thrown.

    • documentId

      protected String documentId

      Id of the document(-version) to query preview images for. If set, objectId is ignored.

    • startPage

      protected int startPage

      First page number of the document to process a preview image for. The number of the first page of a document is 1. If this value is ≤ 0, 1 is assumed.

    • endPage

      protected int endPage

      Last page number of the document to process a preview image for. If this value is ≤ 0, all pages of the document ≥ startPage are process. If 0 < endPage ≤ startPage holds, only the startPage will be processed.

    • previewSize

      protected int previewSize
      Desired size of the preview images. Valid values are defined in PreviewImageInfoC.

    • processDocument

      protected boolean processDocument

      If processDocument is true, not only the URLs for each page are generated but also preview images are processed for the pages (startPage+1) to endPage in the background.

    • renderAnnotations

      protected boolean renderAnnotations

      Enables rendering of annotations. If renderAnnotations is true, the preview images will also contain the annotations. If the preview images should contain the annotations but not the preview of the document page itself, also set renderOnlyAnnotations to true.

    • renderAnnotationsOnly

      protected boolean renderAnnotationsOnly

      Does only has an effect, if renderAnnotations is true. If set to true the annotations will be rendered but the rendering of document pages will be omitted.

    • renderAnnotationsData

      protected boolean renderAnnotationsData

      Does only has an effect, if renderAnnotations is true. If set to true there will be details rendered near the annotations. Details are the annotation's author and create date.

  • Constructor Details

    • PreviewImageInfo

      public PreviewImageInfo()

  • Method Details

    • getObjectId

      public String getObjectId()

    • setObjectId

      public void setObjectId(String objectId)

    • getDocumentId

      public String getDocumentId()

    • setDocumentId

      public void setDocumentId(String documentId)

    • getPreviewSize

      public int getPreviewSize()

    • setPreviewSize

      public void setPreviewSize(int previewSize)

    • isProcessDocument

      public boolean isProcessDocument()

    • setProcessDocument

      public void setProcessDocument(boolean processDocument)

    • getStartPage

      public int getStartPage()

    • setStartPage

      public void setStartPage(int startPage)

    • getEndPage

      public int getEndPage()

    • setEndPage

      public void setEndPage(int endPage)

    • isRenderAnnotations

      public boolean isRenderAnnotations()

    • setRenderAnnotations

      public void setRenderAnnotations(boolean renderAnnotations)

    • isRenderAnnotationsOnly

      public boolean isRenderAnnotationsOnly()

    • setRenderAnnotationsOnly

      public void setRenderAnnotationsOnly(boolean renderAnnotationsOnly)

    • isRenderAnnotationsData

      public boolean isRenderAnnotationsData()

    • setRenderAnnotationsData

      public void setRenderAnnotationsData(boolean renderAnnotationsData)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object