Package com.logicaldoc.webservice.soap

Interface DocumentService

    • Method Detail

      • create

        WSDocument create​(String sid,
                  WSDocument document,
                  javax.activation.DataHandler content)
           throws Exception
        Create a new document. The user can completely customize the document through a value object containing the document's metadata
        Parameters:
        sid - identifier of the session
        document - Web service value object containing the document's metadata
        content - The document's binary content
        Returns:
        The value object containing the document's metadata
        Throws:
        Exception - error in the server application

      • delete

        void delete​(String sid,
            long docId)
     throws Exception
        Deletes an existing document with the given identifier.
        Parameters:
        sid - identifier of the session
        docId - The document id
        Throws:
        Exception - error in the server application

      • lock

        void lock​(String sid,
          long docId)
   throws Exception
        Locks an existing document with the given identifier.
        Parameters:
        sid - identifier of the session
        docId - The document id
        Throws:
        Exception - error in the server application

      • unlock

        void unlock​(String sid,
            long docId)
     throws Exception
        Unlocks an existing document with the given identifier.
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        Throws:
        Exception - error in the server application

      • rename

        void rename​(String sid,
            long docId,
            String name)
     throws Exception
        Renames the title of an existing document with the given identifier.
        Parameters:
        sid - identifier of the session
        docId - The document id
        name - The new document title
        Throws:
        Exception - error in the server application

      • move

        void move​(String sid,
          long docId,
          long folderId)
   throws Exception
        Moves an existing document with the given identifier.
        Parameters:
        sid - identifier of the session
        docId - The document id
        folderId - Identifier of the new document's folder
        Throws:
        Exception - error in the server application

      • copy

        WSDocument copy​(String sid,
                long docId,
                long folderId)
         throws Exception
        Copies a document into another folder.
        Parameters:
        sid - identifier of the session
        docId - The document id
        folderId - Identifier of the new document's folder
        Returns:
        The created copy
        Throws:
        Exception - error in the server application

      • getDocument

        WSDocument getDocument​(String sid,
                       long docId)
                throws Exception
        Gets the metadata of an existing document with the given identifier
        Parameters:
        sid - identifier of the session
        docId - The document id
        Returns:
        A value object containing the document's metadata
        Throws:
        Exception - error in the server application

      • getDocumentByCustomId

        WSDocument getDocumentByCustomId​(String sid,
                                 String customId)
                          throws Exception
        Gets document metadata of an existing document with the given custom identifier
        Parameters:
        sid - identifier of the session
        customId - The custom id
        Returns:
        A value object containing the document's metadata
        Throws:
        Exception - error in the server application

      • getDocuments

        WSDocument[] getDocuments​(String sid,
                          Long[] docIds)
                   throws Exception
        Gets document metadata of a collection of existing documents with the given identifiers
        Parameters:
        sid - identifier of the session
        docIds - identifiers of the documents
        Returns:
        the list of documents
        Throws:
        Exception - error in the server application

      • getAliases

        WSDocument[] getAliases​(String sid,
                        long docId)
                 throws Exception
        Gets the aliases of the given document
        Parameters:
        sid - identifier of the session
        docId - The master document ID
        Returns:
        Arrays of aliases
        Throws:
        Exception - error in the server application

      • update

        void update​(String sid,
            WSDocument document)
     throws Exception
        Updates an existing document with the value object containing the document's metadata
        Parameters:
        sid - identifier of the session
        document - The value object containing the document's metadata
        Throws:
        Exception - error in the server application

      • getContent

        javax.activation.DataHandler getContent​(String sid,
                                        long docId)
                                 throws Exception
        Gets the content of an existing document with the given identifier
        Parameters:
        sid - identifier of the session
        docId - The document id
        Returns:
        The requested document's binary
        Throws:
        Exception - error in the server application

      • getExtractedText

        String getExtractedText​(String sid,
                        long docId)
                 throws Exception
        Gets the document's text stored in the full-text index
        Parameters:
        sid - identifier of the session
        docId - The document id
        Returns:
        The requested document's text
        Throws:
        Exception - error in the server application

      • getVersionContent

        javax.activation.DataHandler getVersionContent​(String sid,
                                               long docId,
                                               String version)
                                        throws Exception
        Gets the content of a specific version of a document
        Parameters:
        sid - identifier of the session
        docId - The document id
        version - The specific version(it can be empty)
        Returns:
        The requested version's binary
        Throws:
        Exception - error in the server application

      • getResource

        javax.activation.DataHandler getResource​(String sid,
                                         long docId,
                                         String fileVersion,
                                         String suffix)
                                  throws Exception
        Gets the content of a resource associated to the given document.
        Parameters:
        sid - identifier of the session
        docId - The document id
        fileVersion - The specific file version(it can be empty)
        suffix - Suffix specification(it can be empty, conversion.pdf to get the PDF conversion)
        Returns:
        The requested resource's binary
        Throws:
        Exception - error in the server application

      • checkout

        void checkout​(String sid,
              long docId)
       throws Exception
        Checks out an existing document with the given identifier.
        Parameters:
        sid - identifier of the session
        docId - The document id
        Throws:
        Exception - error in the server application

      • checkin

        void checkin​(String sid,
             long docId,
             String comment,
             String filename,
             boolean release,
             javax.activation.DataHandler content)
      throws Exception
        Checks in an existing document with the given identifier to create a new version.
        Parameters:
        sid - identifier of the session
        docId - The document id
        comment - The check in operation comment
        filename - The document file name
        release - True if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)
        content - The document's binary content
        Throws:
        Exception - error in the server application

      • checkinDocument

        void checkinDocument​(String sid,
                     long docId,
                     String comment,
                     String filename,
                     boolean release,
                     WSDocument docVO,
                     javax.activation.DataHandler content)
              throws Exception
        Checks in an existing document with the given identifier to create a new version.
        Parameters:
        sid - identifier of the session
        docId - The document id
        comment - The check in operation comment
        filename - The document file name
        release - True if this is a new release(e.g.: 2.0) rather than a subversion(e.g.: 1.1)
        docVO - metadata for the document
        content - The document's binary content
        Throws:
        Exception - error in the server application

      • replaceFile

        void replaceFile​(String sid,
                 long docId,
                 String fileVersion,
                 String comment,
                 javax.activation.DataHandler content)
          throws Exception
        Replaces the file associated to a given version.
        Parameters:
        sid - identifier of the session
        docId - The document id
        fileVersion - The file version
        comment - The comment left for this action
        content - The file's binary content
        Throws:
        Exception - if an error occurs, this exception is thrown

      • promoteVersion

        void promoteVersion​(String sid,
                    long docId,
                    String version)
             throws Exception
        Promotes an old version to the current default one. If you promote a prior version, what it does is make it the default version again. (regardless of there being many versions).
        Parameters:
        sid - identifier of the session
        docId - the document to be updated
        version - the version
        Throws:
        Exception - if an error occurs, this exception is thrown

      • upload

        long upload​(String sid,
            Long docId,
            Long folderId,
            boolean release,
            String filename,
            String language,
            javax.activation.DataHandler content)
     throws Exception
        Creates a new document or updates an existing one.
        Parameters:
        sid - identifier of the session
        docId - The document id (optional)
        folderId - The folder id (optional)
        release - True if this is a major release(eg: 2.0) rather than a minor release(eg: 1.12)
        filename - The document file name
        language - The language for the document
        content - The document's binary content
        Returns:
        The created/updated document's ID
        Throws:
        Exception - error in the server application

      • uploadResource

        void uploadResource​(String sid,
                    long docId,
                    String fileVersion,
                    String suffix,
                    javax.activation.DataHandler content)
             throws Exception
        Uploads a new resource attached to the given document. If the resource already exists it is overwritten.
        Parameters:
        sid - Session identifier
        docId - The document id
        fileVersion - The specific file version(it can be empty)
        suffix - Suffix specification(it cannot be empty, use 'conversion.pdf' to put the PDF conversion)
        content - The resource's binary content
        Throws:
        Exception - error in the server application

      • isReadable

        boolean isReadable​(String sid,
                   long docId)
            throws Exception
        Tests if a document is readable
        Parameters:
        sid - identifier of the session
        docId - The document id
        Returns:
        True if the identifier denotes a document, otherwise false
        Throws:
        Exception - error in the server application

      • restore

        void restore​(String sid,
             long docId,
             long folderId)
      throws Exception
        Restores a deleted document
        Parameters:
        sid - identifier of the session
        docId - The document id
        folderId - Id of the folder in which the document must be restored
        Throws:
        Exception - error in the server application

      • getVersions

        WSDocument[] getVersions​(String sid,
                         long docId)
                  throws Exception
        Gets the version history of an existing document with the given identifier
        Parameters:
        sid - identifier of the session
        docId - The document id
        Returns:
        Array of versions
        Throws:
        Exception - error in the server application

      • getVersion

        WSDocument getVersion​(String sid,
                      long docId,
                      String version)
               throws Exception
        Gets a specific version
        Parameters:
        sid - identifier of the session
        docId - The document id
        version - The version number
        Returns:
        The version
        Throws:
        Exception - error in the server application

      • listDocuments

        WSDocument[] listDocuments​(String sid,
                           long folderId,
                           String fileName)
                    throws Exception
        Gets a document in a specific folder
        Parameters:
        sid - identifier of the session
        folderId - The folder id
        fileName - Optional file name filter
        Returns:
        A value object containing the document's metadata
        Throws:
        Exception - error in the server application

      • getRecentDocuments

        WSDocument[] getRecentDocuments​(String sid,
                                Integer maxHits)
                         throws Exception
        Lists of last modified documents of the current session.
        Parameters:
        sid - identifier of the session
        maxHits - Maximum number of returned records
        Returns:
        Array of documents
        Throws:
        Exception - error in the server application

      • sendEmail

        void sendEmail​(String sid,
               Long[] docIds,
               String recipients,
               String subject,
               String message)
        throws Exception
        Sends a set of documents as mail attachments
        Parameters:
        sid - identifier of the session
        docIds - Set of document identifiers
        recipients - Set of recipients(comma separated)
        subject - The email subject
        message - The email message body
        Throws:
        Exception - error in the server application

      • createAlias

        WSDocument createAlias​(String sid,
                       long docId,
                       long folderId,
                       String type)
                throws Exception
        Creates a new document alias for the given document inside a specified folder
        Parameters:
        sid - identifier of the session
        docId - The original document id
        folderId - Identifier of the folder in which will be stored the alias.
        type - Type of the alias
        Returns:
        The value object containing the document's metadata
        Throws:
        Exception - error in the server application

      • link

        WSLink link​(String sid,
            long doc1,
            long doc2,
            String type)
     throws Exception
        Creates a new link between two documents.
        Parameters:
        sid - identifier of the session
        doc1 - ID of document 1
        doc2 - ID of document 2
        type - The link type(it can be empty)
        Returns:
        the new link
        Throws:
        Exception - error in the server application

      • getLinks

        WSLink[] getLinks​(String sid,
                  long docId)
           throws Exception
        Gets all the links of a specific document
        Parameters:
        sid - Session identifier
        docId - ID of the document
        Returns:
        The new links of the document
        Throws:
        Exception - error in the server application

      • deleteLink

        void deleteLink​(String sid,
                long id)
         throws Exception
        Removes an existing link
        Parameters:
        sid - identifier of the session
        id - ID of the link
        Throws:
        Exception - error in the server application

      • reindex

        void reindex​(String sid,
             long docId,
             String content)
      throws Exception
        Re-indexes(or indexes from scratch) a document
        Parameters:
        sid - Session identifier
        docId - The document id
        content - The content to be used (if null the file is parsed)
        Throws:
        Exception - error in the server application

      • createPdf

        void createPdf​(String sid,
               long docId,
               String fileVersion)
        throws Exception
        Creates the PDF conversion of the given document. If the conversion was already created, nothing will happen.
        Parameters:
        sid - identifier of the session
        docId - The document id
        fileVersion - The specific file version(it can be empty)
        Throws:
        Exception - error in the server application

      • createThumbnail

        void createThumbnail​(String sid,
                     long docId,
                     String fileVersion,
                     String type)
              throws Exception
        Creates the thumbnail of the given document. If the thumbnail was already created, nothing will happen.
        Parameters:
        sid - Session identifier
        docId - The document id
        fileVersion - The specific file version(it can be empty)
        type - The thumbnail type(eg: thumb, tile, mobile, thumbXXX where XXX is a resolution in pixels)
        Throws:
        Exception - error in the server application

      • createDownloadTicket

        String createDownloadTicket​(String sid,
                            long docId,
                            String suffix,
                            Integer expireHours,
                            String expireDate,
                            Integer maxDownloads)
                     throws Exception
        Creates a new download ticket
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        suffix - can be null or 'conversion.pdf'
        expireHours - expiration time expressed in hours
        expireDate - exact expiration date expressed in the format yyyy-MM-dd
        maxDownloads - maximum number of downloads allowed
        Returns:
        the download ticket
        Throws:
        Exception - error in the server application

      • setPassword

        void setPassword​(String sid,
                 long docId,
                 String password)
          throws Exception
        Puts a password protection to the document
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        password - the new password
        Throws:
        Exception - error in the server application

      • unsetPassword

        void unsetPassword​(String sid,
                   long docId,
                   String currentPassword)
            throws Exception
        Removes the password protection from the document
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        currentPassword - the password
        Throws:
        Exception - error in the server application

      • unprotect

        boolean unprotect​(String sid,
                  long docId,
                  String password)
           throws Exception
        Unprotects a document that is password protected. If the given password is right, the document remains unprotected for the duration of the session
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        password - the password
        Returns:
        was it uprotected?
        Throws:
        Exception - error in the server application

      • addNote

        WSNote addNote​(String sid,
               long docId,
               String note)
        throws Exception
        Adds a new note for the given document
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        note - text of the note
        Returns:
        the created note
        Throws:
        Exception - error in the server application

      • saveNote

        WSNote saveNote​(String sid,
                long docId,
                WSNote note)
         throws Exception
        Adds a new note for the given document
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        note - the note to add
        Returns:
        the added note
        Throws:
        Exception - error in the server application

      • deleteNote

        void deleteNote​(String sid,
                long noteId)
         throws Exception
        Adds a new note for the given document
        Parameters:
        sid - identifier of the session
        noteId - identifier of the note
        Throws:
        Exception - error in the server application

      • getNotes

        WSNote[] getNotes​(String sid,
                  long docId)
           throws Exception
        Gets the notes for the given document
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        Returns:
        array of notes
        Throws:
        Exception - error in the server application

      • deleteVersion

        String deleteVersion​(String sid,
                     long docId,
                     String version)
              throws Exception
        Deletes a version of a document with the given identifiers. You can not delete the latest version of a document
        Parameters:
        sid - identifier of the session
        docId - The document id
        version - The specific version
        Returns:
        the latest version
        Throws:
        Exception - when the version to delete is not available

      • rateDocument

        WSRating rateDocument​(String sid,
                      long docId,
                      int vote)
               throws Exception
        Puts a new rating on the given document
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        vote - the vote
        Returns:
        the rating
        Throws:
        Exception - error in the server application

      • getRatings

        WSRating[] getRatings​(String sid,
                      long docId)
               throws Exception
        Gets all the ratings of the given document
        Parameters:
        sid - identifier of the session
        docId - identifier of the document
        Returns:
        the array of ratings
        Throws:
        Exception - error in the server application