Package com.logicaldoc.impex.webservice.soap

Interface ImpexService

All Known Implementing Classes:

SoapImpexClient, SoapImpexService

public interface ImpexService

Handles impex archives

Since:

7.1.2

Author:

Marco Meschieri - LogicalDOC

Method Summary

Modifier and Type	Method	Description
void	addDocumentToExportArchive(String sid, long archiveId, long docId)	Adds a document to an existing export archive
void	closeExportArchive(String sid, long archiveId)	Closes an export archive
long	createExportArchive(String sid, String name, String description)	Defines a new export archive.
void	deleteExportArchive(String sid, long archiveId)	Deletes an export archive
Long	getArchiveIdByName(String sid, String name)	Retrieves the ID of an existing archive

Method Details

createExportArchive

long createExportArchive(String sid,
 String name,
 String description)
                  throws com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Defines a new export archive.

Parameters:

sid - Session identifier

name - Name of the archive, mandatory

description - Description of the archive, optional

Returns:

The id of the newly created export archive

Throws:

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

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

addDocumentToExportArchive

void addDocumentToExportArchive(String sid,
 long archiveId,
 long docId)
                         throws com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
com.logicaldoc.gui.common.client.ServerException

Adds a document to an existing export archive

Parameters:

sid - Session identifier

archiveId - identifier of the archive to be used

docId - identifier of the document to be added

Throws:

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

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

com.logicaldoc.gui.common.client.ServerException - Error in the application server

closeExportArchive

void closeExportArchive(String sid,
 long archiveId)
                 throws com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Closes an export archive

Parameters:

sid - Session identifier

archiveId - identifier of the archive to be closed

Throws:

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

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

deleteExportArchive

void deleteExportArchive(String sid,
 long archiveId)
                  throws com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Deletes an export archive

Parameters:

sid - Session identifier

archiveId - identifier of the archive to be closed

Throws:

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

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

getArchiveIdByName

Long getArchiveIdByName(String sid,
 String name)
                 throws com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Retrieves the ID of an existing archive

Parameters:

sid - Session identifier

name - Name of the archive

Returns:

The id of the archive

Throws:

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

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