Interface WebDocumentInstance

  • All Superinterfaces:
    EnumWebPersistableState, Persistable, WebResultSetInstance

    public interface WebDocumentInstance
    extends WebResultSetInstance
    The WebDocumentInstance interface represents an instance of a document. A document instance is identified by its message ID. This interface can be used to retrieve the results of a document and to access its inbox records. A WebDocumentInstance can only be obtained from the WebDocumentSource interface.
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Detail

      • getResults

        java.lang.String getResults()
                             throws WebObjectsException
        Attempts to obtain the document results from the Intelligence Server, and return those results.
        Returns:
        The document Execution Results String.
        Throws:
        WebObjectsException - Thrown if the method has difficulty in contacting the Intelligence Server.
      • getMessage

        WebDocumentMessage getMessage()
                               throws WebObjectsException
        Returns a WebDocumentMessage object for the current document. No attempt is made to ensure that the document message returned is populated. Thus, unless the document message was already existing and populated, this call returns an unpopulated document message object.
        Returns:
        WebDocumentMessage for the current document.
        Throws:
        WebObjectsException - indicates an inability to obtain the message information from the Intelligence Server.
      • getPDFData

        byte[] getPDFData()
                   throws WebObjectsException
        Returns the PDF Data.
        Returns:
        byte[] the pdf PDF
        Throws:
        WebObjectsException - if an error was encountered on IServer.
        Since:
        MicroStrategy Web 7.5.0
      • setViewMode

        void setViewMode​(int viewMode)
        Sets the view mode. View mode should be a value from EnumWebDocumentViewMode
        Parameters:
        viewMode - the desired view mode.
        Since:
        MicroStrategy Web 7.5.4
      • getViewMode

        int getViewMode()
        Returns the view mode. Possbile View mode values are listed in EnumWebDocumentViewMode
        Returns:
        int the view mode.
        Since:
        MicroStrategy Web 7.5.4