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 Detail

createExportArchive

long createExportArchive(String sid,
                         String name,
                         String description)
                  throws Exception

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:

Exception - error in the server

addDocumentToExportArchive

void addDocumentToExportArchive(String sid,
                                long archiveId,
                                long docId)
                         throws Exception

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:

Exception - error in the server

closeExportArchive

void closeExportArchive(String sid,
                        long archiveId)
                 throws Exception

Closes an export archive

Parameters:

sid - Session identifier

archiveId - identifier of the archive to be closed

Throws:

Exception - error in the server

deleteExportArchive

void deleteExportArchive(String sid,
                         long archiveId)
                  throws Exception

Deletes an export archive

Parameters:

sid - Session identifier

archiveId - identifier of the archive to be closed

Throws:

Exception - error in the server

getArchiveIdByName

Long getArchiveIdByName(String sid,
                        String name)
                 throws Exception

Retrieves the ID of an existing archive

Parameters:

sid - Session identifier

name - Name of the archive

Returns:

The id of the archive

Throws:

Exception - error in the server