com.logicaldoc.gui.frontend.client.services

Interface ArchiveService

All Superinterfaces:

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

@RemoteServiceRelativePath(value="archive")
public interface ArchiveService
extends com.google.gwt.user.client.rpc.RemoteService

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

Since:

6.0

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocuments(String sid, long archiveId, long[] documentIds) Adds a set of documents(their current versions) to the given archive
void	addFolder(String sid, long archiveId, long rootId) Adds a a folder(the current version of the contained documents at any level).
void	delete(String sid, long archiveId) Deletes a specific archive by its ID
void	deleteFolder(String sid, String folderName) Deletes a folder in impex/in folder.
void	deleteIncremental(String sid, long id) Deletes a given incremental configuration
GUIArchive	deleteVersions(String sid, long archiveId, Long[] versionIds) Deletes a set of versions from the given archive
GUIArchive	load(String sid, long archiveId) Loads a given archive
GUIIncrementalArchive	loadIncremental(String sid, long id) Loads an incremental configuration
GUIArchive	save(String sid, GUIArchive archive) Saves/Updates a given archive
GUIIncrementalArchive	saveIncremental(String sid, GUIIncrementalArchive incremental) Saves the passed incremental configuration
void	setStatus(String sid, long archiveId, int status) Change the status of the given Archive
String	signArchive(String sid, long userId, long archiveId) Verifies the user signature file, extracts the original file contained into the uploaded m7m file and checks if its digest and the archive's file digest are equals, then signs and marks the archive.
void	startImport(String sid, String folderName) Create a new import archive for the specified bundle folder
GUIVersion[]	verifyArchive(String sid, long archiveId) Verifies the archive with the given identifier.

Method Detail

delete

void delete(String sid,
          long archiveId)
            throws InvalidSessionException

Deletes a specific archive by its ID

Throws:

InvalidSessionException

deleteVersions

GUIArchive deleteVersions(String sid,
                        long archiveId,
                        Long[] versionIds)
                          throws InvalidSessionException

Deletes a set of versions from the given archive

Throws:

InvalidSessionException

setStatus

void setStatus(String sid,
             long archiveId,
             int status)
               throws InvalidSessionException

Change the status of the given Archive

Throws:

InvalidSessionException

save

GUIArchive save(String sid,
              GUIArchive archive)
                throws InvalidSessionException

Saves/Updates a given archive

Throws:

InvalidSessionException

load

GUIArchive load(String sid,
              long archiveId)
                throws InvalidSessionException

Loads a given archive

Throws:

InvalidSessionException

addDocuments

void addDocuments(String sid,
                long archiveId,
                long[] documentIds)
                  throws InvalidSessionException

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

Throws:

InvalidSessionException

addFolder

void addFolder(String sid,
             long archiveId,
             long rootId)
               throws InvalidSessionException

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

Throws:

InvalidSessionException

deleteIncremental

void deleteIncremental(String sid,
                     long id)
                       throws InvalidSessionException

Deletes a given incremental configuration

Throws:

InvalidSessionException

loadIncremental

GUIIncrementalArchive loadIncremental(String sid,
                                    long id)
                                      throws InvalidSessionException

Loads an incremental configuration

Throws:

InvalidSessionException

saveIncremental

GUIIncrementalArchive saveIncremental(String sid,
                                    GUIIncrementalArchive incremental)
                                      throws InvalidSessionException

Saves the passed incremental configuration

Throws:

InvalidSessionException

deleteFolder

void deleteFolder(String sid,
                String folderName)
                  throws InvalidSessionException

Deletes a folder in impex/in folder.

Throws:

InvalidSessionException

startImport

void startImport(String sid,
               String folderName)
                 throws InvalidSessionException

Create a new import archive for the specified bundle folder

Throws:

InvalidSessionException

signArchive

String signArchive(String sid,
                 long userId,
                 long archiveId)
                   throws InvalidSessionException

Verifies the user signature file, extracts the original file contained into the uploaded m7m file and checks if its digest and the archive's file digest are equals, then signs and marks the archive.

Parameters:

sid - The session identifier

userid - Identifier of the user that is performing the signature

archiveId - Identifier of the archive to sign

Returns:

'ok' if no errors occurred, otherwise returns the error message.

Throws:

InvalidSessionException

verifyArchive

GUIVersion[] verifyArchive(String sid,
                         long archiveId)
                           throws InvalidSessionException

Verifies the archive with the given identifier. First of all, checks if there are some archived documents that missing a required signature (looking at their template). Then validates the archive.

Parameters:

sid - The session identifier

archiveId - Identifier of the archive to verify

Returns:

Array of documents versions that have some errors.

Throws:

InvalidSessionException