Package com.snowbound.contenthandler.interfaces

Interface DocumentNotesInterface

  • All Known Implementing Classes:
    FileContentHandler, RestfulHttpContentHandler
    public interface DocumentNotesInterface
    Enables the document notes feature. These methods load and delete document notes. Notes are comments left on a specific document, marked with the date they were created and the creating user's name. They can be viewed in the VirtualViewer interface or exported/printed appended to the document content.

    • Method Detail

      • getNotesContent

        ContentHandlerResult getNotesContent​(ContentHandlerInput input)
                              throws VirtualViewerAPIException
        Returns the contents of the document notes XML file for the specified document key in the form of a byte array.
        Parameters:
        input - ContentHandlerInput containing the following values:
        Every row is an expected value in the ContentHandlerInput. The first column is the string key for the value. The second column is the type of the value. The third column is the detailed description of the value.
        KeyTypeDescription
        KEY_DOCUMENT_ID java.lang.String The key representing the document. Can be retrieved with String documentId = input.getDocumentId(); .
        KEY_CLIENT_INSTANCE_ID java.lang.String Custom configurable value used to pass data from client to content handler. If not set then will be the session ID. Can be retrieved with String clientInstanceId = input.getClientInstanceId();
        KEY_HTTP_SERVLET_REQUEST javax.servlet.http.HttpServletRequest Request that called this method. Can be retrieved with HttpServletRequest request = input.getHttpServletRequest();
        Returns:
        ContentHandlerResult with the following values:
        Every row is an expected value in the ContentHandlerResult. The first column is the string key for the value. The second column is the type of the value. The third column is the detailed description of the value.
        KeyTypeDescription
        KEY_NOTES_CONTENT byte[] Contents of the document notes XML file, or null if no document notes have been saved.
        Throws:
        VirtualViewerAPIException - if content handler throws exception

      • deleteNotesContent

        ContentHandlerResult deleteNotesContent​(ContentHandlerInput input)
                                 throws VirtualViewerAPIException
        Called when the client has requested to delete all notes for the specified document.
        Parameters:
        input - ContentHandlerInput containing the following values:
        Every row is an expected value in the ContentHandlerInput. The first column is the string key for the value. The second column is the type of the value. The third column is the detailed description of the value.
        KeyTypeDescription
        KEY_DOCUMENT_ID java.lang.String The key representing the document. Can be retrieved with String documentId = input.getDocumentId(); .
        KEY_CLIENT_INSTANCE_ID java.lang.String Custom configurable value used to pass data from client to content handler. If not set then will be the session ID. Can be retrieved with String clientInstanceId = input.getClientInstanceId();
        KEY_HTTP_SERVLET_REQUEST javax.servlet.http.HttpServletRequest Request that called this method. Can be retrieved with HttpServletRequest request = input.getHttpServletRequest();
        Returns:
        ContentHandlerResult with no values currently expected.
        Throws:
        VirtualViewerAPIException - if content handler throws exception