Package com.logicaldoc.enterprise.webservice.soap

Interface EnterpriseDocumentService

All Known Implementing Classes:

RestEnterpriseDocumentService, SoapEnterpriseDocumentClient, SoapEnterpriseDocumentService

public interface EnterpriseDocumentService

Enterprise Document Web Service definition interface

Since:

8.1.2

Author:

Marco Meschieri - LogicalDOC

Method Summary

Modifier and Type	Method	Description
void	checkin(String sid, long docId, String comment, String filename, boolean release, com.logicaldoc.webservice.model.WSDocument docVO)	Checks in an existing document with the given identifier to create a new version, it uses the uploaded chunks
com.logicaldoc.webservice.model.WSDocument	create(String sid, com.logicaldoc.webservice.model.WSDocument document)	Creates a new document using the uploaded chunks.
void	deleteChunks(String sid)
javax.activation.DataHandler	downloadChunk(String sid, long docId, String version, long start, long length)
com.logicaldoc.webservice.model.WSDocument	merge(String sid, List<Long> docIds, long targetFolderId, String fileName)	Merges a set of documents into a single PDF
void	uploadChunk(String sid, javax.activation.DataHandler content)

Method Details

downloadChunk

javax.activation.DataHandler downloadChunk(String sid,
 long docId,
 String version,
 long start,
 long length)
                                    throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException,
com.logicaldoc.core.security.authorization.PermissionException

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

com.logicaldoc.core.security.authorization.PermissionException

uploadChunk

void uploadChunk(String sid,
 javax.activation.DataHandler content)
          throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

deleteChunks

void deleteChunks(String sid)
           throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

create

com.logicaldoc.webservice.model.WSDocument create(String sid,
 com.logicaldoc.webservice.model.WSDocument document)
                                           throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Creates a new document using the uploaded chunks. 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

Returns:

The value object containing the document's metadata

Throws:

IOException - I/O error

com.logicaldoc.core.PersistenceException - Error in the database layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

checkin

void checkin(String sid,
 long docId,
 String comment,
 String filename,
 boolean release,
 com.logicaldoc.webservice.model.WSDocument docVO)
      throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Checks in an existing document with the given identifier to create a new version, it uses the uploaded chunks

Parameters:

sid - Session identifier

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 - new metadata for the document

Throws:

IOException - I/O error

com.logicaldoc.core.PersistenceException - Error in the database layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

merge

com.logicaldoc.webservice.model.WSDocument merge(String sid,
 List<Long> docIds,
 long targetFolderId,
 String fileName)
                                          throws com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
IOException,
com.logicaldoc.core.security.authorization.PermissionException,
com.logicaldoc.core.security.authorization.UnexistingResourceException

Merges a set of documents into a single PDF

Parameters:

sid - Session identifier

docIds - identifiers of the documents to merge

targetFolderId - identifier of the folder that will receive the merged PDF

fileName - file name of the merged PDF

Returns:

the newly created merged document

Throws:

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

com.logicaldoc.core.PersistenceException - Error in the database layer

IOException - I/O error

com.logicaldoc.core.security.authorization.UnexistingResourceException - Ome of the referenced documents do not exist

com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions