Package com.logicaldoc.gui.frontend.client.services

Interface ImpexService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@RemoteServiceRelativePath("impex")
public interface ImpexService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Impex Service. This service allows r/w operations on export archives.

Since:

6.0

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ImpexService.Instance

Method Summary

Modifier and Type	Method	Description
void	addDocuments(long archiveId, long[] documentIds)	Adds a set of documents(their current versions) to the given archive
void	addFolder(long archiveId, long folderId)	Adds a a folder(the current version of the contained documents at any level)
void	delete(long archiveId)	Deletes a specific archive by its identifier
void	deleteFolder(String folderName)	Deletes a folder in impex/in folder
void	deleteIncremental(long id)	Deletes a given incremental configuration
GUIArchive	deleteVersions(long archiveId, Long[] versionIds)	Deletes a set of versions from the given archive
GUIArchive	load(long archiveId)	Loads a given archive
GUIIncrementalArchive	loadIncremental(long id)	Loads an incremental configuration
GUIArchive	save(GUIArchive archive)	Saves/Updates a given archive
GUIIncrementalArchive	saveIncremental(GUIIncrementalArchive incremental)	Saves the passed incremental configuration
void	setStatus(long archiveId, int status)	Change the status of the given Archive
void	startImport(String folderName)	Create a new import archive for the specified bundle folder

Method Detail

delete

void delete(long archiveId)
     throws ServerException

Deletes a specific archive by its identifier

Parameters:

archiveId - identifier of the archive

Throws:

ServerException - an error happened in the server application

deleteVersions

GUIArchive deleteVersions(long archiveId,
                          Long[] versionIds)
                   throws ServerException

Deletes a set of versions from the given archive

Parameters:

archiveId - identifier of the archive

versionIds - identifiers od the versions

Returns:

the archive

Throws:

ServerException - an error happened in the server application

setStatus

void setStatus(long archiveId,
               int status)
        throws ServerException

Change the status of the given Archive

Parameters:

archiveId - identifier of the archive

status - the status of the archive

Throws:

ServerException - an error happened in the server application

save

GUIArchive save(GUIArchive archive)
         throws ServerException

Saves/Updates a given archive

Parameters:

archive - the archive to save

Returns:

the saved archive

Throws:

ServerException - an error happened in the server application

load

GUIArchive load(long archiveId)
         throws ServerException

Loads a given archive

Parameters:

archiveId - identifier of the archive

Returns:

the archive retrieved by the server application

Throws:

ServerException - an error happened in the server application

addDocuments

void addDocuments(long archiveId,
                  long[] documentIds)
           throws ServerException

Adds a set of documents(their current versions) to the given archive

Parameters:

archiveId - identifier of the archive

documentIds - identifiers of the documents

Throws:

ServerException - an error happened in the server application

addFolder

void addFolder(long archiveId,
               long folderId)
        throws ServerException

Adds a a folder(the current version of the contained documents at any level)

Parameters:

archiveId - identifier of the archive

folderId - identifier od the folder to add

Throws:

ServerException - an error happened in the server application

deleteIncremental

void deleteIncremental(long id)
                throws ServerException

Deletes a given incremental configuration

Parameters:

id - identifier of the incremental configuration

Throws:

ServerException - an error happened in the server application

loadIncremental

GUIIncrementalArchive loadIncremental(long id)
                               throws ServerException

Loads an incremental configuration

Parameters:

id - identifier of the incremental configuration

Returns:

the configuration retrieved by the server application

Throws:

ServerException - an error happened in the server application

saveIncremental

GUIIncrementalArchive saveIncremental(GUIIncrementalArchive incremental)
                               throws ServerException

Saves the passed incremental configuration

Parameters:

incremental - the configuration to save

Returns:

the saved configuration

Throws:

ServerException - an error happened in the server application

deleteFolder

void deleteFolder(String folderName)
           throws ServerException

Deletes a folder in impex/in folder

Parameters:

folderName - name of the sub-folder

Throws:

ServerException - an error happened in the server application

startImport

void startImport(String folderName)
          throws ServerException

Create a new import archive for the specified bundle folder

Parameters:

folderName - name of the sub-folder

Throws:

ServerException - an error happened in the server application