Class SapViewerResponse

java.lang.Object
com.saperion.ngc.json.SapViewerResponse

public class SapViewerResponse extends Object
A SapViewerResponse contains the data about the opened document that is sent to the SAPViewer after the document was loaded on server-side. It is used on the client to open the document in the viewer.
  • Constructor Details

    • SapViewerResponse

      public SapViewerResponse()
  • Method Details

    • getDocumentId

      public String getDocumentId()
      Returns:
      the JSON ID of the document
    • setDocumentId

      public void setDocumentId(String documentId)
      Parameters:
      documentId - the JSON ID of the document
    • getDocumentRows

      public SapViewerResponse.StructureRow[] getDocumentRows()
      Returns:
      the rows of the structure
    • setDocumentRows

      public void setDocumentRows(SapViewerResponse.StructureRow[] documentRows)
      Parameters:
      documentRows - the rows of the structure
    • isDownloadAllowed

      public boolean isDownloadAllowed()
      Returns:
      true if the document can be downloaded
    • setDownloadAllowed

      public void setDownloadAllowed(boolean downloadAllowed)
      Parameters:
      downloadAllowed - true if the document can be downloaded
    • getRevisionId

      public String getRevisionId()
      Returns:
      thr revision-ID of the document
    • getFirstViewableElement

      public int getFirstViewableElement()
      Returns:
      the number of the first element in the structure that can be viewed
    • setFirstViewableElement

      public void setFirstViewableElement(int firstViewableElement)
      Parameters:
      firstViewableElement - the number of the first element in the structure that can be viewed
    • getMailingUrl

      public String getMailingUrl()
      Returns:
      the URL used for mailing with attachment
    • setMailingUrl

      public void setMailingUrl(String mailingUrl)
      Parameters:
      mailingUrl - the URL used for mailing with attachment
    • getUrlMailingUrl

      public String getUrlMailingUrl()
      Returns:
      the URL used for mailing with link
    • setUrlMailingUrl

      public void setUrlMailingUrl(String urlMailingUrl)
      Parameters:
      urlMailingUrl - the URL used for mailing with link
    • isShowStructure

      public boolean isShowStructure()
      Returns:
      true if the structure is shown
    • setShowStructure

      public void setShowStructure(boolean showStructure)
      Parameters:
      showStructure - true if the structure is shown
    • getPagecount

      public int getPagecount()
      Returns:
      the count of pages of the document
    • setPagecount

      public void setPagecount(int pagecount)
      Parameters:
      pagecount - the count of pages of the document
    • getSimpleDocumentId

      public String getSimpleDocumentId()
      Returns:
      the simple string ID of the document
    • setSimpleDocumentId

      public void setSimpleDocumentId(String simpleDocumentId)
      Parameters:
      simpleDocumentId - the simple string ID of the document