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

Interface ShareFileService

All Superinterfaces:

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

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

The client side stub for the ShareFile Service.

Since:

7.2.1

Author:

Marco Meschieri - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ShareFileService.Instance

Method Summary

Modifier and Type	Method	Description
boolean	exportDocuments(String targetFolder, long[] folderIds, long[] docIds)	Exports documents and folders into ShareFille
int	importDocuments(long targetFolder, String[] itemIds)
String[]	loadSettings()	Retrieve the settings saved for connecting to FileShare
void	saveSettings(String hostname, String username, String password)	Save the settings used by the FileShare module

Method Detail

exportDocuments

boolean exportDocuments(String targetFolder,
                        long[] folderIds,
                        long[] docIds)
                 throws ServerException

Exports documents and folders into ShareFille

Parameters:

targetFolder - the target folder in ShareFile

folderIds - Ids of the folders to be imported (all sub-folders and docs will be imported as well)

docIds - Ids of the documents to be imported

Returns:

if the document have been exported successfully

Throws:

ServerException - an error happened in the server application

importDocuments

int importDocuments(long targetFolder,
                    String[] itemIds)
             throws ServerException

Throws:

ServerException

saveSettings

void saveSettings(String hostname,
                  String username,
                  String password)
           throws ServerException

Save the settings used by the FileShare module

Parameters:

hostname - name of the host

username - username

password - password

Throws:

ServerException - an error happened in the server application

loadSettings

String[] loadSettings()
               throws ServerException

Retrieve the settings saved for connecting to FileShare

Returns:

the settings

Throws:

ServerException - an error happened in the server application