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)
void	uploadChunk(String sid, javax.activation.DataHandler content)

Method Detail

downloadChunk

javax.activation.DataHandler downloadChunk(String sid,
                                           long docId,
                                           String version,
                                           long start,
                                           long length)
                                    throws Exception

Throws:

Exception

uploadChunk

void uploadChunk(String sid,
                 javax.activation.DataHandler content)
          throws Exception

Throws:

Exception

deleteChunks

void deleteChunks(String sid)
           throws Exception

Throws:

Exception

create

com.logicaldoc.webservice.model.WSDocument create(String sid,
                                                  com.logicaldoc.webservice.model.WSDocument document)
                                           throws Exception

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:

Exception - error in the server or in the database

checkin

void checkin(String sid,
             long docId,
             String comment,
             String filename,
             boolean release,
             com.logicaldoc.webservice.model.WSDocument docVO)
      throws Exception

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:

Exception - error in the server or in the database